@azure/arm-appservice

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AccessControlEntryAction

AccessControlEntryAction: "Permit" | "Deny"

Defines values for AccessControlEntryAction. Possible values include: 'Permit', 'Deny'

readonly
enum: {string}

AppServiceCertificateOrdersBeginCreateOrUpdateCertificateResponse

AppServiceCertificateOrdersBeginCreateOrUpdateCertificateResponse: AppServiceCertificateResource & object

Contains response data for the beginCreateOrUpdateCertificate operation.

AppServiceCertificateOrdersBeginCreateOrUpdateResponse

AppServiceCertificateOrdersBeginCreateOrUpdateResponse: AppServiceCertificateOrder & object

Contains response data for the beginCreateOrUpdate operation.

AppServiceCertificateOrdersCreateOrUpdateCertificateResponse

AppServiceCertificateOrdersCreateOrUpdateCertificateResponse: AppServiceCertificateResource & object

Contains response data for the createOrUpdateCertificate operation.

AppServiceCertificateOrdersCreateOrUpdateResponse

AppServiceCertificateOrdersCreateOrUpdateResponse: AppServiceCertificateOrder & object

Contains response data for the createOrUpdate operation.

AppServiceCertificateOrdersGetCertificateResponse

AppServiceCertificateOrdersGetCertificateResponse: AppServiceCertificateResource & object

Contains response data for the getCertificate operation.

AppServiceCertificateOrdersGetResponse

AppServiceCertificateOrdersGetResponse: AppServiceCertificateOrder & object

Contains response data for the get operation.

AppServiceCertificateOrdersListByResourceGroupNextResponse

AppServiceCertificateOrdersListByResourceGroupNextResponse: AppServiceCertificateOrderCollection & object

Contains response data for the listByResourceGroupNext operation.

AppServiceCertificateOrdersListByResourceGroupResponse

AppServiceCertificateOrdersListByResourceGroupResponse: AppServiceCertificateOrderCollection & object

Contains response data for the listByResourceGroup operation.

AppServiceCertificateOrdersListCertificatesNextResponse

AppServiceCertificateOrdersListCertificatesNextResponse: AppServiceCertificateCollection & object

Contains response data for the listCertificatesNext operation.

AppServiceCertificateOrdersListCertificatesResponse

AppServiceCertificateOrdersListCertificatesResponse: AppServiceCertificateCollection & object

Contains response data for the listCertificates operation.

AppServiceCertificateOrdersListNextResponse

AppServiceCertificateOrdersListNextResponse: AppServiceCertificateOrderCollection & object

Contains response data for the listNext operation.

AppServiceCertificateOrdersListResponse

AppServiceCertificateOrdersListResponse: AppServiceCertificateOrderCollection & object

Contains response data for the list operation.

AppServiceCertificateOrdersRetrieveCertificateActionsResponse

AppServiceCertificateOrdersRetrieveCertificateActionsResponse: Array<CertificateOrderAction> & object

Contains response data for the retrieveCertificateActions operation.

AppServiceCertificateOrdersRetrieveCertificateEmailHistoryResponse

AppServiceCertificateOrdersRetrieveCertificateEmailHistoryResponse: Array<CertificateEmail> & object

Contains response data for the retrieveCertificateEmailHistory operation.

AppServiceCertificateOrdersRetrieveSiteSealResponse

AppServiceCertificateOrdersRetrieveSiteSealResponse: SiteSeal & object

Contains response data for the retrieveSiteSeal operation.

AppServiceCertificateOrdersUpdateCertificateResponse

AppServiceCertificateOrdersUpdateCertificateResponse: AppServiceCertificateResource & object

Contains response data for the updateCertificate operation.

AppServiceCertificateOrdersUpdateResponse

AppServiceCertificateOrdersUpdateResponse: AppServiceCertificateOrder & object

Contains response data for the update operation.

AppServiceEnvironmentsBeginChangeVnetNextResponse

AppServiceEnvironmentsBeginChangeVnetNextResponse: WebAppCollection & object

Contains response data for the beginChangeVnetNext operation.

AppServiceEnvironmentsBeginChangeVnetResponse

AppServiceEnvironmentsBeginChangeVnetResponse: WebAppCollection & object

Contains response data for the beginChangeVnet operation.

AppServiceEnvironmentsBeginCreateOrUpdateMultiRolePoolResponse

AppServiceEnvironmentsBeginCreateOrUpdateMultiRolePoolResponse: WorkerPoolResource & object

Contains response data for the beginCreateOrUpdateMultiRolePool operation.

AppServiceEnvironmentsBeginCreateOrUpdateResponse

AppServiceEnvironmentsBeginCreateOrUpdateResponse: AppServiceEnvironmentResource & object

Contains response data for the beginCreateOrUpdate operation.

AppServiceEnvironmentsBeginCreateOrUpdateWorkerPoolResponse

AppServiceEnvironmentsBeginCreateOrUpdateWorkerPoolResponse: WorkerPoolResource & object

Contains response data for the beginCreateOrUpdateWorkerPool operation.

AppServiceEnvironmentsBeginResumeNextResponse

AppServiceEnvironmentsBeginResumeNextResponse: WebAppCollection & object

Contains response data for the beginResumeNext operation.

AppServiceEnvironmentsBeginResumeResponse

AppServiceEnvironmentsBeginResumeResponse: WebAppCollection & object

Contains response data for the beginResume operation.

AppServiceEnvironmentsBeginSuspendNextResponse

AppServiceEnvironmentsBeginSuspendNextResponse: WebAppCollection & object

Contains response data for the beginSuspendNext operation.

AppServiceEnvironmentsBeginSuspendResponse

AppServiceEnvironmentsBeginSuspendResponse: WebAppCollection & object

Contains response data for the beginSuspend operation.

AppServiceEnvironmentsChangeVnetNextResponse

AppServiceEnvironmentsChangeVnetNextResponse: WebAppCollection & object

Contains response data for the changeVnetNext operation.

AppServiceEnvironmentsChangeVnetResponse

AppServiceEnvironmentsChangeVnetResponse: WebAppCollection & object

Contains response data for the changeVnet operation.

AppServiceEnvironmentsCreateOrUpdateMultiRolePoolResponse

AppServiceEnvironmentsCreateOrUpdateMultiRolePoolResponse: WorkerPoolResource & object

Contains response data for the createOrUpdateMultiRolePool operation.

AppServiceEnvironmentsCreateOrUpdateResponse

AppServiceEnvironmentsCreateOrUpdateResponse: AppServiceEnvironmentResource & object

Contains response data for the createOrUpdate operation.

AppServiceEnvironmentsCreateOrUpdateWorkerPoolResponse

AppServiceEnvironmentsCreateOrUpdateWorkerPoolResponse: WorkerPoolResource & object

Contains response data for the createOrUpdateWorkerPool operation.

AppServiceEnvironmentsGetDiagnosticsItemResponse

AppServiceEnvironmentsGetDiagnosticsItemResponse: HostingEnvironmentDiagnostics & object

Contains response data for the getDiagnosticsItem operation.

AppServiceEnvironmentsGetMultiRolePoolResponse

AppServiceEnvironmentsGetMultiRolePoolResponse: WorkerPoolResource & object

Contains response data for the getMultiRolePool operation.

AppServiceEnvironmentsGetResponse

AppServiceEnvironmentsGetResponse: AppServiceEnvironmentResource & object

Contains response data for the get operation.

AppServiceEnvironmentsGetWorkerPoolResponse

AppServiceEnvironmentsGetWorkerPoolResponse: WorkerPoolResource & object

Contains response data for the getWorkerPool operation.

AppServiceEnvironmentsListAppServicePlansNextResponse

AppServiceEnvironmentsListAppServicePlansNextResponse: AppServicePlanCollection & object

Contains response data for the listAppServicePlansNext operation.

AppServiceEnvironmentsListAppServicePlansResponse

AppServiceEnvironmentsListAppServicePlansResponse: AppServicePlanCollection & object

Contains response data for the listAppServicePlans operation.

AppServiceEnvironmentsListByResourceGroupNextResponse

AppServiceEnvironmentsListByResourceGroupNextResponse: AppServiceEnvironmentCollection & object

Contains response data for the listByResourceGroupNext operation.

AppServiceEnvironmentsListByResourceGroupResponse

AppServiceEnvironmentsListByResourceGroupResponse: AppServiceEnvironmentCollection & object

Contains response data for the listByResourceGroup operation.

AppServiceEnvironmentsListCapacitiesNextResponse

AppServiceEnvironmentsListCapacitiesNextResponse: StampCapacityCollection & object

Contains response data for the listCapacitiesNext operation.

AppServiceEnvironmentsListCapacitiesResponse

AppServiceEnvironmentsListCapacitiesResponse: StampCapacityCollection & object

Contains response data for the listCapacities operation.

AppServiceEnvironmentsListDiagnosticsResponse

AppServiceEnvironmentsListDiagnosticsResponse: Array<HostingEnvironmentDiagnostics> & object

Contains response data for the listDiagnostics operation.

AppServiceEnvironmentsListMetricDefinitionsResponse

AppServiceEnvironmentsListMetricDefinitionsResponse: MetricDefinition & object

Contains response data for the listMetricDefinitions operation.

AppServiceEnvironmentsListMetricsNextResponse

AppServiceEnvironmentsListMetricsNextResponse: ResourceMetricCollection & object

Contains response data for the listMetricsNext operation.

AppServiceEnvironmentsListMetricsResponse

AppServiceEnvironmentsListMetricsResponse: ResourceMetricCollection & object

Contains response data for the listMetrics operation.

AppServiceEnvironmentsListMultiRoleMetricDefinitionsNextResponse

AppServiceEnvironmentsListMultiRoleMetricDefinitionsNextResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMultiRoleMetricDefinitionsNext operation.

AppServiceEnvironmentsListMultiRoleMetricDefinitionsResponse

AppServiceEnvironmentsListMultiRoleMetricDefinitionsResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMultiRoleMetricDefinitions operation.

AppServiceEnvironmentsListMultiRoleMetricsNextResponse

AppServiceEnvironmentsListMultiRoleMetricsNextResponse: ResourceMetricCollection & object

Contains response data for the listMultiRoleMetricsNext operation.

AppServiceEnvironmentsListMultiRoleMetricsResponse

AppServiceEnvironmentsListMultiRoleMetricsResponse: ResourceMetricCollection & object

Contains response data for the listMultiRoleMetrics operation.

AppServiceEnvironmentsListMultiRolePoolInstanceMetricDefinitionsNextResponse

AppServiceEnvironmentsListMultiRolePoolInstanceMetricDefinitionsNextResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMultiRolePoolInstanceMetricDefinitionsNext operation.

AppServiceEnvironmentsListMultiRolePoolInstanceMetricDefinitionsResponse

AppServiceEnvironmentsListMultiRolePoolInstanceMetricDefinitionsResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMultiRolePoolInstanceMetricDefinitions operation.

AppServiceEnvironmentsListMultiRolePoolInstanceMetricsNextResponse

AppServiceEnvironmentsListMultiRolePoolInstanceMetricsNextResponse: ResourceMetricCollection & object

Contains response data for the listMultiRolePoolInstanceMetricsNext operation.

AppServiceEnvironmentsListMultiRolePoolInstanceMetricsResponse

AppServiceEnvironmentsListMultiRolePoolInstanceMetricsResponse: ResourceMetricCollection & object

Contains response data for the listMultiRolePoolInstanceMetrics operation.

AppServiceEnvironmentsListMultiRolePoolSkusNextResponse

AppServiceEnvironmentsListMultiRolePoolSkusNextResponse: SkuInfoCollection & object

Contains response data for the listMultiRolePoolSkusNext operation.

AppServiceEnvironmentsListMultiRolePoolSkusResponse

AppServiceEnvironmentsListMultiRolePoolSkusResponse: SkuInfoCollection & object

Contains response data for the listMultiRolePoolSkus operation.

AppServiceEnvironmentsListMultiRolePoolsNextResponse

AppServiceEnvironmentsListMultiRolePoolsNextResponse: WorkerPoolCollection & object

Contains response data for the listMultiRolePoolsNext operation.

AppServiceEnvironmentsListMultiRolePoolsResponse

AppServiceEnvironmentsListMultiRolePoolsResponse: WorkerPoolCollection & object

Contains response data for the listMultiRolePools operation.

AppServiceEnvironmentsListMultiRoleUsagesNextResponse

AppServiceEnvironmentsListMultiRoleUsagesNextResponse: UsageCollection & object

Contains response data for the listMultiRoleUsagesNext operation.

AppServiceEnvironmentsListMultiRoleUsagesResponse

AppServiceEnvironmentsListMultiRoleUsagesResponse: UsageCollection & object

Contains response data for the listMultiRoleUsages operation.

AppServiceEnvironmentsListNextResponse

AppServiceEnvironmentsListNextResponse: AppServiceEnvironmentCollection & object

Contains response data for the listNext operation.

AppServiceEnvironmentsListOperationsResponse

AppServiceEnvironmentsListOperationsResponse: Array<Operation> & object

Contains response data for the listOperations operation.

AppServiceEnvironmentsListResponse

AppServiceEnvironmentsListResponse: AppServiceEnvironmentCollection & object

Contains response data for the list operation.

AppServiceEnvironmentsListUsagesNextResponse

AppServiceEnvironmentsListUsagesNextResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsagesNext operation.

AppServiceEnvironmentsListUsagesResponse

AppServiceEnvironmentsListUsagesResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsages operation.

AppServiceEnvironmentsListVipsResponse

AppServiceEnvironmentsListVipsResponse: AddressResponse & object

Contains response data for the listVips operation.

AppServiceEnvironmentsListWebAppsNextResponse

AppServiceEnvironmentsListWebAppsNextResponse: WebAppCollection & object

Contains response data for the listWebAppsNext operation.

AppServiceEnvironmentsListWebAppsResponse

AppServiceEnvironmentsListWebAppsResponse: WebAppCollection & object

Contains response data for the listWebApps operation.

AppServiceEnvironmentsListWebWorkerMetricDefinitionsNextResponse

AppServiceEnvironmentsListWebWorkerMetricDefinitionsNextResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listWebWorkerMetricDefinitionsNext operation.

AppServiceEnvironmentsListWebWorkerMetricDefinitionsResponse

AppServiceEnvironmentsListWebWorkerMetricDefinitionsResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listWebWorkerMetricDefinitions operation.

AppServiceEnvironmentsListWebWorkerMetricsNextResponse

AppServiceEnvironmentsListWebWorkerMetricsNextResponse: ResourceMetricCollection & object

Contains response data for the listWebWorkerMetricsNext operation.

AppServiceEnvironmentsListWebWorkerMetricsResponse

AppServiceEnvironmentsListWebWorkerMetricsResponse: ResourceMetricCollection & object

Contains response data for the listWebWorkerMetrics operation.

AppServiceEnvironmentsListWebWorkerUsagesNextResponse

AppServiceEnvironmentsListWebWorkerUsagesNextResponse: UsageCollection & object

Contains response data for the listWebWorkerUsagesNext operation.

AppServiceEnvironmentsListWebWorkerUsagesResponse

AppServiceEnvironmentsListWebWorkerUsagesResponse: UsageCollection & object

Contains response data for the listWebWorkerUsages operation.

AppServiceEnvironmentsListWorkerPoolInstanceMetricDefinitionsNextResponse

AppServiceEnvironmentsListWorkerPoolInstanceMetricDefinitionsNextResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listWorkerPoolInstanceMetricDefinitionsNext operation.

AppServiceEnvironmentsListWorkerPoolInstanceMetricDefinitionsResponse

AppServiceEnvironmentsListWorkerPoolInstanceMetricDefinitionsResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listWorkerPoolInstanceMetricDefinitions operation.

AppServiceEnvironmentsListWorkerPoolInstanceMetricsNextResponse

AppServiceEnvironmentsListWorkerPoolInstanceMetricsNextResponse: ResourceMetricCollection & object

Contains response data for the listWorkerPoolInstanceMetricsNext operation.

AppServiceEnvironmentsListWorkerPoolInstanceMetricsResponse

AppServiceEnvironmentsListWorkerPoolInstanceMetricsResponse: ResourceMetricCollection & object

Contains response data for the listWorkerPoolInstanceMetrics operation.

AppServiceEnvironmentsListWorkerPoolSkusNextResponse

AppServiceEnvironmentsListWorkerPoolSkusNextResponse: SkuInfoCollection & object

Contains response data for the listWorkerPoolSkusNext operation.

AppServiceEnvironmentsListWorkerPoolSkusResponse

AppServiceEnvironmentsListWorkerPoolSkusResponse: SkuInfoCollection & object

Contains response data for the listWorkerPoolSkus operation.

AppServiceEnvironmentsListWorkerPoolsNextResponse

AppServiceEnvironmentsListWorkerPoolsNextResponse: WorkerPoolCollection & object

Contains response data for the listWorkerPoolsNext operation.

AppServiceEnvironmentsListWorkerPoolsResponse

AppServiceEnvironmentsListWorkerPoolsResponse: WorkerPoolCollection & object

Contains response data for the listWorkerPools operation.

AppServiceEnvironmentsResumeNextResponse

AppServiceEnvironmentsResumeNextResponse: WebAppCollection & object

Contains response data for the resumeNext operation.

AppServiceEnvironmentsResumeResponse

AppServiceEnvironmentsResumeResponse: WebAppCollection & object

Contains response data for the resume operation.

AppServiceEnvironmentsSuspendNextResponse

AppServiceEnvironmentsSuspendNextResponse: WebAppCollection & object

Contains response data for the suspendNext operation.

AppServiceEnvironmentsSuspendResponse

AppServiceEnvironmentsSuspendResponse: WebAppCollection & object

Contains response data for the suspend operation.

AppServiceEnvironmentsUpdateMultiRolePoolResponse

AppServiceEnvironmentsUpdateMultiRolePoolResponse: WorkerPoolResource & object

Contains response data for the updateMultiRolePool operation.

AppServiceEnvironmentsUpdateResponse

AppServiceEnvironmentsUpdateResponse: AppServiceEnvironmentResource & object

Contains response data for the update operation.

AppServiceEnvironmentsUpdateWorkerPoolResponse

AppServiceEnvironmentsUpdateWorkerPoolResponse: WorkerPoolResource & object

Contains response data for the updateWorkerPool operation.

AppServicePlanRestrictions

Defines values for AppServicePlanRestrictions. Possible values include: 'None', 'Free', 'Shared', 'Basic', 'Standard', 'Premium'

readonly
enum: {string}

AppServicePlansBeginCreateOrUpdateResponse

AppServicePlansBeginCreateOrUpdateResponse: AppServicePlan & object

Contains response data for the beginCreateOrUpdate operation.

AppServicePlansCreateOrUpdateResponse

AppServicePlansCreateOrUpdateResponse: AppServicePlan & object

Contains response data for the createOrUpdate operation.

AppServicePlansCreateOrUpdateVnetRouteResponse

AppServicePlansCreateOrUpdateVnetRouteResponse: VnetRoute & object

Contains response data for the createOrUpdateVnetRoute operation.

AppServicePlansGetHybridConnectionPlanLimitResponse

AppServicePlansGetHybridConnectionPlanLimitResponse: HybridConnectionLimits & object

Contains response data for the getHybridConnectionPlanLimit operation.

AppServicePlansGetHybridConnectionResponse

AppServicePlansGetHybridConnectionResponse: HybridConnection & object

Contains response data for the getHybridConnection operation.

AppServicePlansGetResponse

AppServicePlansGetResponse: AppServicePlan & object

Contains response data for the get operation.

AppServicePlansGetRouteForVnetResponse

AppServicePlansGetRouteForVnetResponse: Array<VnetRoute> & object

Contains response data for the getRouteForVnet operation.

AppServicePlansGetServerFarmSkusResponse

AppServicePlansGetServerFarmSkusResponse: object

Contains response data for the getServerFarmSkus operation.

Type declaration

AppServicePlansGetVnetFromServerFarmResponse

AppServicePlansGetVnetFromServerFarmResponse: VnetInfo & object

Contains response data for the getVnetFromServerFarm operation.

AppServicePlansGetVnetGatewayResponse

AppServicePlansGetVnetGatewayResponse: VnetGateway & object

Contains response data for the getVnetGateway operation.

AppServicePlansListByResourceGroupNextResponse

AppServicePlansListByResourceGroupNextResponse: AppServicePlanCollection & object

Contains response data for the listByResourceGroupNext operation.

AppServicePlansListByResourceGroupResponse

AppServicePlansListByResourceGroupResponse: AppServicePlanCollection & object

Contains response data for the listByResourceGroup operation.

AppServicePlansListCapabilitiesResponse

AppServicePlansListCapabilitiesResponse: Array<Capability> & object

Contains response data for the listCapabilities operation.

AppServicePlansListHybridConnectionKeysResponse

AppServicePlansListHybridConnectionKeysResponse: HybridConnectionKey & object

Contains response data for the listHybridConnectionKeys operation.

AppServicePlansListHybridConnectionsNextResponse

AppServicePlansListHybridConnectionsNextResponse: HybridConnectionCollection & object

Contains response data for the listHybridConnectionsNext operation.

AppServicePlansListHybridConnectionsResponse

AppServicePlansListHybridConnectionsResponse: HybridConnectionCollection & object

Contains response data for the listHybridConnections operation.

AppServicePlansListMetricDefintionsNextResponse

AppServicePlansListMetricDefintionsNextResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefintionsNext operation.

AppServicePlansListMetricDefintionsResponse

AppServicePlansListMetricDefintionsResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefintions operation.

AppServicePlansListMetricsNextResponse

AppServicePlansListMetricsNextResponse: ResourceMetricCollection & object

Contains response data for the listMetricsNext operation.

AppServicePlansListMetricsResponse

AppServicePlansListMetricsResponse: ResourceMetricCollection & object

Contains response data for the listMetrics operation.

AppServicePlansListNextResponse

AppServicePlansListNextResponse: AppServicePlanCollection & object

Contains response data for the listNext operation.

AppServicePlansListResponse

AppServicePlansListResponse: AppServicePlanCollection & object

Contains response data for the list operation.

AppServicePlansListRoutesForVnetResponse

AppServicePlansListRoutesForVnetResponse: Array<VnetRoute> & object

Contains response data for the listRoutesForVnet operation.

AppServicePlansListUsagesNextResponse

AppServicePlansListUsagesNextResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsagesNext operation.

AppServicePlansListUsagesResponse

AppServicePlansListUsagesResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsages operation.

AppServicePlansListVnetsResponse

AppServicePlansListVnetsResponse: Array<VnetInfo> & object

Contains response data for the listVnets operation.

AppServicePlansListWebAppsByHybridConnectionNextResponse

AppServicePlansListWebAppsByHybridConnectionNextResponse: ResourceCollection & object

Contains response data for the listWebAppsByHybridConnectionNext operation.

AppServicePlansListWebAppsByHybridConnectionResponse

AppServicePlansListWebAppsByHybridConnectionResponse: ResourceCollection & object

Contains response data for the listWebAppsByHybridConnection operation.

AppServicePlansListWebAppsNextResponse

AppServicePlansListWebAppsNextResponse: WebAppCollection & object

Contains response data for the listWebAppsNext operation.

AppServicePlansListWebAppsResponse

AppServicePlansListWebAppsResponse: WebAppCollection & object

Contains response data for the listWebApps operation.

AppServicePlansUpdateResponse

AppServicePlansUpdateResponse: AppServicePlan & object

Contains response data for the update operation.

AppServicePlansUpdateVnetGatewayResponse

AppServicePlansUpdateVnetGatewayResponse: VnetGateway & object

Contains response data for the updateVnetGateway operation.

AppServicePlansUpdateVnetRouteResponse

AppServicePlansUpdateVnetRouteResponse: VnetRoute & object

Contains response data for the updateVnetRoute operation.

AutoHealActionType

AutoHealActionType: "Recycle" | "LogEvent" | "CustomAction"

Defines values for AutoHealActionType. Possible values include: 'Recycle', 'LogEvent', 'CustomAction'

readonly
enum: {string}

AzureResourceType

AzureResourceType: "Website" | "TrafficManager"

Defines values for AzureResourceType. Possible values include: 'Website', 'TrafficManager'

readonly
enum: {string}

AzureStorageState

AzureStorageState: "Ok" | "InvalidCredentials" | "InvalidShare"

Defines values for AzureStorageState. Possible values include: 'Ok', 'InvalidCredentials', 'InvalidShare'

readonly
enum: {string}

AzureStorageType

AzureStorageType: "AzureFiles" | "AzureBlob"

Defines values for AzureStorageType. Possible values include: 'AzureFiles', 'AzureBlob'

readonly
enum: {string}

BackupItemStatus

Defines values for BackupItemStatus. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created', 'Skipped', 'PartiallySucceeded', 'DeleteInProgress', 'DeleteFailed', 'Deleted'

readonly
enum: {string}

BackupRestoreOperationType

BackupRestoreOperationType: "Default" | "Clone" | "Relocation" | "Snapshot" | "CloudFS"

Defines values for BackupRestoreOperationType. Possible values include: 'Default', 'Clone', 'Relocation', 'Snapshot', 'CloudFS'

readonly
enum: {string}

BuiltInAuthenticationProvider

BuiltInAuthenticationProvider: "AzureActiveDirectory" | "Facebook" | "Google" | "MicrosoftAccount" | "Twitter"

Defines values for BuiltInAuthenticationProvider. Possible values include: 'AzureActiveDirectory', 'Facebook', 'Google', 'MicrosoftAccount', 'Twitter'

readonly
enum: {string}

CertificateOrderActionType

Defines values for CertificateOrderActionType. Possible values include: 'CertificateIssued', 'CertificateOrderCanceled', 'CertificateOrderCreated', 'CertificateRevoked', 'DomainValidationComplete', 'FraudDetected', 'OrgNameChange', 'OrgValidationComplete', 'SanDrop', 'FraudCleared', 'CertificateExpired', 'CertificateExpirationWarning', 'FraudDocumentationRequired', 'Unknown'

readonly
enum: {string}

CertificateOrderStatus

Defines values for CertificateOrderStatus. Possible values include: 'Pendingissuance', 'Issued', 'Revoked', 'Canceled', 'Denied', 'Pendingrevocation', 'PendingRekey', 'Unused', 'Expired', 'NotSubmitted'

readonly
enum: {string}

CertificateProductType

CertificateProductType: "StandardDomainValidatedSsl" | "StandardDomainValidatedWildCardSsl"

Defines values for CertificateProductType. Possible values include: 'StandardDomainValidatedSsl', 'StandardDomainValidatedWildCardSsl'

readonly
enum: {string}

CertificateRegistrationProviderListOperationsNextResponse

CertificateRegistrationProviderListOperationsNextResponse: CsmOperationCollection & object

Contains response data for the listOperationsNext operation.

CertificateRegistrationProviderListOperationsResponse

CertificateRegistrationProviderListOperationsResponse: CsmOperationCollection & object

Contains response data for the listOperations operation.

CertificatesCreateOrUpdateResponse

CertificatesCreateOrUpdateResponse: Certificate & object

Contains response data for the createOrUpdate operation.

CertificatesGetResponse

CertificatesGetResponse: Certificate & object

Contains response data for the get operation.

CertificatesListByResourceGroupNextResponse

CertificatesListByResourceGroupNextResponse: CertificateCollection & object

Contains response data for the listByResourceGroupNext operation.

CertificatesListByResourceGroupResponse

CertificatesListByResourceGroupResponse: CertificateCollection & object

Contains response data for the listByResourceGroup operation.

CertificatesListNextResponse

CertificatesListNextResponse: CertificateCollection & object

Contains response data for the listNext operation.

CertificatesListResponse

CertificatesListResponse: CertificateCollection & object

Contains response data for the list operation.

CertificatesUpdateResponse

CertificatesUpdateResponse: Certificate & object

Contains response data for the update operation.

Channels

Channels: "Notification" | "Api" | "Email" | "Webhook" | "All"

Defines values for Channels. Possible values include: 'Notification', 'Api', 'Email', 'Webhook', 'All'

readonly
enum: {string}

CheckNameAvailabilityResponse

CheckNameAvailabilityResponse: ResourceNameAvailability & object

Contains response data for the checkNameAvailability operation.

CheckNameResourceTypes

Defines values for CheckNameResourceTypes. Possible values include: 'Site', 'Slot', 'HostingEnvironment', 'PublishingUser', 'Microsoft.Web/sites', 'Microsoft.Web/sites/slots', 'Microsoft.Web/hostingEnvironments', 'Microsoft.Web/publishingUsers'

readonly
enum: {string}

CloneAbilityResult

CloneAbilityResult: "Cloneable" | "PartiallyCloneable" | "NotCloneable"

Defines values for CloneAbilityResult. Possible values include: 'Cloneable', 'PartiallyCloneable', 'NotCloneable'

readonly
enum: {string}

ComputeModeOptions

ComputeModeOptions: "Shared" | "Dedicated" | "Dynamic"

Defines values for ComputeModeOptions. Possible values include: 'Shared', 'Dedicated', 'Dynamic'

readonly
enum: {string}

ConnectionStringType

Defines values for ConnectionStringType. Possible values include: 'MySql', 'SQLServer', 'SQLAzure', 'Custom', 'NotificationHub', 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'

readonly
enum: {string}

ContinuousWebJobStatus

ContinuousWebJobStatus: "Initializing" | "Starting" | "Running" | "PendingRestart" | "Stopped"

Defines values for ContinuousWebJobStatus. Possible values include: 'Initializing', 'Starting', 'Running', 'PendingRestart', 'Stopped'

readonly
enum: {string}

CustomHostNameDnsRecordType

CustomHostNameDnsRecordType: "CName" | "A"

Defines values for CustomHostNameDnsRecordType. Possible values include: 'CName', 'A'

readonly
enum: {string}

DatabaseType

DatabaseType: "SqlAzure" | "MySql" | "LocalMySql" | "PostgreSql"

Defines values for DatabaseType. Possible values include: 'SqlAzure', 'MySql', 'LocalMySql', 'PostgreSql'

readonly
enum: {string}

DeletedWebAppsListNextResponse

DeletedWebAppsListNextResponse: DeletedWebAppCollection & object

Contains response data for the listNext operation.

DeletedWebAppsListResponse

DeletedWebAppsListResponse: DeletedWebAppCollection & object

Contains response data for the list operation.

DiagnosticsExecuteSiteAnalysisResponse

DiagnosticsExecuteSiteAnalysisResponse: DiagnosticAnalysis & object

Contains response data for the executeSiteAnalysis operation.

DiagnosticsExecuteSiteAnalysisSlotResponse

DiagnosticsExecuteSiteAnalysisSlotResponse: DiagnosticAnalysis & object

Contains response data for the executeSiteAnalysisSlot operation.

DiagnosticsExecuteSiteDetectorResponse

DiagnosticsExecuteSiteDetectorResponse: DiagnosticDetectorResponse & object

Contains response data for the executeSiteDetector operation.

DiagnosticsExecuteSiteDetectorSlotResponse

DiagnosticsExecuteSiteDetectorSlotResponse: DiagnosticDetectorResponse & object

Contains response data for the executeSiteDetectorSlot operation.

DiagnosticsGetHostingEnvironmentDetectorResponseResponse

DiagnosticsGetHostingEnvironmentDetectorResponseResponse: DetectorResponse & object

Contains response data for the getHostingEnvironmentDetectorResponse operation.

DiagnosticsGetSiteAnalysisResponse

DiagnosticsGetSiteAnalysisResponse: DiagnosticAnalysis & object

Contains response data for the getSiteAnalysis operation.

DiagnosticsGetSiteAnalysisSlotResponse

DiagnosticsGetSiteAnalysisSlotResponse: DiagnosticAnalysis & object

Contains response data for the getSiteAnalysisSlot operation.

DiagnosticsGetSiteDetectorNextResponse

DiagnosticsGetSiteDetectorNextResponse: DiagnosticDetectorCollection & object

Contains response data for the getSiteDetectorNext operation.

DiagnosticsGetSiteDetectorResponse

DiagnosticsGetSiteDetectorResponse: DiagnosticDetectorCollection & object

Contains response data for the getSiteDetector operation.

DiagnosticsGetSiteDetectorResponseResponse

DiagnosticsGetSiteDetectorResponseResponse: DetectorResponse & object

Contains response data for the getSiteDetectorResponse operation.

DiagnosticsGetSiteDetectorResponseSlotResponse

DiagnosticsGetSiteDetectorResponseSlotResponse: DetectorResponse & object

Contains response data for the getSiteDetectorResponseSlot operation.

DiagnosticsGetSiteDetectorSlotNextResponse

DiagnosticsGetSiteDetectorSlotNextResponse: DiagnosticDetectorCollection & object

Contains response data for the getSiteDetectorSlotNext operation.

DiagnosticsGetSiteDetectorSlotResponse

DiagnosticsGetSiteDetectorSlotResponse: DiagnosticDetectorCollection & object

Contains response data for the getSiteDetectorSlot operation.

DiagnosticsGetSiteDiagnosticCategoryResponse

DiagnosticsGetSiteDiagnosticCategoryResponse: DiagnosticCategory & object

Contains response data for the getSiteDiagnosticCategory operation.

DiagnosticsGetSiteDiagnosticCategorySlotResponse

DiagnosticsGetSiteDiagnosticCategorySlotResponse: DiagnosticCategory & object

Contains response data for the getSiteDiagnosticCategorySlot operation.

DiagnosticsListHostingEnvironmentDetectorResponsesNextResponse

DiagnosticsListHostingEnvironmentDetectorResponsesNextResponse: DetectorResponseCollection & object

Contains response data for the listHostingEnvironmentDetectorResponsesNext operation.

DiagnosticsListHostingEnvironmentDetectorResponsesResponse

DiagnosticsListHostingEnvironmentDetectorResponsesResponse: DetectorResponseCollection & object

Contains response data for the listHostingEnvironmentDetectorResponses operation.

DiagnosticsListSiteAnalysesNextResponse

DiagnosticsListSiteAnalysesNextResponse: DiagnosticAnalysisCollection & object

Contains response data for the listSiteAnalysesNext operation.

DiagnosticsListSiteAnalysesResponse

DiagnosticsListSiteAnalysesResponse: DiagnosticAnalysisCollection & object

Contains response data for the listSiteAnalyses operation.

DiagnosticsListSiteAnalysesSlotNextResponse

DiagnosticsListSiteAnalysesSlotNextResponse: DiagnosticAnalysisCollection & object

Contains response data for the listSiteAnalysesSlotNext operation.

DiagnosticsListSiteAnalysesSlotResponse

DiagnosticsListSiteAnalysesSlotResponse: DiagnosticAnalysisCollection & object

Contains response data for the listSiteAnalysesSlot operation.

DiagnosticsListSiteDetectorResponsesNextResponse

DiagnosticsListSiteDetectorResponsesNextResponse: DetectorResponseCollection & object

Contains response data for the listSiteDetectorResponsesNext operation.

DiagnosticsListSiteDetectorResponsesResponse

DiagnosticsListSiteDetectorResponsesResponse: DetectorResponseCollection & object

Contains response data for the listSiteDetectorResponses operation.

DiagnosticsListSiteDetectorResponsesSlotNextResponse

DiagnosticsListSiteDetectorResponsesSlotNextResponse: DetectorResponseCollection & object

Contains response data for the listSiteDetectorResponsesSlotNext operation.

DiagnosticsListSiteDetectorResponsesSlotResponse

DiagnosticsListSiteDetectorResponsesSlotResponse: DetectorResponseCollection & object

Contains response data for the listSiteDetectorResponsesSlot operation.

DiagnosticsListSiteDetectorsNextResponse

DiagnosticsListSiteDetectorsNextResponse: DiagnosticDetectorCollection & object

Contains response data for the listSiteDetectorsNext operation.

DiagnosticsListSiteDetectorsResponse

DiagnosticsListSiteDetectorsResponse: DiagnosticDetectorCollection & object

Contains response data for the listSiteDetectors operation.

DiagnosticsListSiteDetectorsSlotNextResponse

DiagnosticsListSiteDetectorsSlotNextResponse: DiagnosticDetectorCollection & object

Contains response data for the listSiteDetectorsSlotNext operation.

DiagnosticsListSiteDetectorsSlotResponse

DiagnosticsListSiteDetectorsSlotResponse: DiagnosticDetectorCollection & object

Contains response data for the listSiteDetectorsSlot operation.

DiagnosticsListSiteDiagnosticCategoriesNextResponse

DiagnosticsListSiteDiagnosticCategoriesNextResponse: DiagnosticCategoryCollection & object

Contains response data for the listSiteDiagnosticCategoriesNext operation.

DiagnosticsListSiteDiagnosticCategoriesResponse

DiagnosticsListSiteDiagnosticCategoriesResponse: DiagnosticCategoryCollection & object

Contains response data for the listSiteDiagnosticCategories operation.

DiagnosticsListSiteDiagnosticCategoriesSlotNextResponse

DiagnosticsListSiteDiagnosticCategoriesSlotNextResponse: DiagnosticCategoryCollection & object

Contains response data for the listSiteDiagnosticCategoriesSlotNext operation.

DiagnosticsListSiteDiagnosticCategoriesSlotResponse

DiagnosticsListSiteDiagnosticCategoriesSlotResponse: DiagnosticCategoryCollection & object

Contains response data for the listSiteDiagnosticCategoriesSlot operation.

DnsType

DnsType: "AzureDns" | "DefaultDomainRegistrarDns"

Defines values for DnsType. Possible values include: 'AzureDns', 'DefaultDomainRegistrarDns'

readonly
enum: {string}

DnsVerificationTestResult

DnsVerificationTestResult: "Passed" | "Failed" | "Skipped"

Defines values for DnsVerificationTestResult. Possible values include: 'Passed', 'Failed', 'Skipped'

readonly
enum: {string}

DomainRegistrationProviderListOperationsNextResponse

DomainRegistrationProviderListOperationsNextResponse: CsmOperationCollection & object

Contains response data for the listOperationsNext operation.

DomainRegistrationProviderListOperationsResponse

DomainRegistrationProviderListOperationsResponse: CsmOperationCollection & object

Contains response data for the listOperations operation.

DomainStatus

Defines values for DomainStatus. Possible values include: 'Active', 'Awaiting', 'Cancelled', 'Confiscated', 'Disabled', 'Excluded', 'Expired', 'Failed', 'Held', 'Locked', 'Parked', 'Pending', 'Reserved', 'Reverted', 'Suspended', 'Transferred', 'Unknown', 'Unlocked', 'Unparked', 'Updated', 'JsonConverterFailed'

readonly
enum: {string}

DomainType

DomainType: "Regular" | "SoftDeleted"

Defines values for DomainType. Possible values include: 'Regular', 'SoftDeleted'

readonly
enum: {string}

DomainsBeginCreateOrUpdateResponse

DomainsBeginCreateOrUpdateResponse: Domain & object

Contains response data for the beginCreateOrUpdate operation.

DomainsCheckAvailabilityResponse

DomainsCheckAvailabilityResponse: DomainAvailablilityCheckResult & object

Contains response data for the checkAvailability operation.

DomainsCreateOrUpdateOwnershipIdentifierResponse

DomainsCreateOrUpdateOwnershipIdentifierResponse: DomainOwnershipIdentifier & object

Contains response data for the createOrUpdateOwnershipIdentifier operation.

DomainsCreateOrUpdateResponse

DomainsCreateOrUpdateResponse: Domain & object

Contains response data for the createOrUpdate operation.

DomainsGetControlCenterSsoRequestResponse

DomainsGetControlCenterSsoRequestResponse: DomainControlCenterSsoRequest & object

Contains response data for the getControlCenterSsoRequest operation.

DomainsGetOwnershipIdentifierResponse

DomainsGetOwnershipIdentifierResponse: DomainOwnershipIdentifier & object

Contains response data for the getOwnershipIdentifier operation.

DomainsGetResponse

DomainsGetResponse: Domain & object

Contains response data for the get operation.

DomainsListByResourceGroupNextResponse

DomainsListByResourceGroupNextResponse: DomainCollection & object

Contains response data for the listByResourceGroupNext operation.

DomainsListByResourceGroupResponse

DomainsListByResourceGroupResponse: DomainCollection & object

Contains response data for the listByResourceGroup operation.

DomainsListNextResponse

DomainsListNextResponse: DomainCollection & object

Contains response data for the listNext operation.

DomainsListOwnershipIdentifiersNextResponse

DomainsListOwnershipIdentifiersNextResponse: DomainOwnershipIdentifierCollection & object

Contains response data for the listOwnershipIdentifiersNext operation.

DomainsListOwnershipIdentifiersResponse

DomainsListOwnershipIdentifiersResponse: DomainOwnershipIdentifierCollection & object

Contains response data for the listOwnershipIdentifiers operation.

DomainsListRecommendationsNextResponse

DomainsListRecommendationsNextResponse: NameIdentifierCollection & object

Contains response data for the listRecommendationsNext operation.

DomainsListRecommendationsResponse

DomainsListRecommendationsResponse: NameIdentifierCollection & object

Contains response data for the listRecommendations operation.

DomainsListResponse

DomainsListResponse: DomainCollection & object

Contains response data for the list operation.

DomainsUpdateOwnershipIdentifierResponse

DomainsUpdateOwnershipIdentifierResponse: DomainOwnershipIdentifier & object

Contains response data for the updateOwnershipIdentifier operation.

DomainsUpdateResponse

DomainsUpdateResponse: Domain & object

Contains response data for the update operation.

FrequencyUnit

FrequencyUnit: "Day" | "Hour"

Defines values for FrequencyUnit. Possible values include: 'Day', 'Hour'

readonly
enum: {string}

FtpsState

FtpsState: "AllAllowed" | "FtpsOnly" | "Disabled"

Defines values for FtpsState. Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'

readonly
enum: {string}

GetPublishingUserResponse

GetPublishingUserResponse: User & object

Contains response data for the getPublishingUser operation.

GetSourceControlResponse

GetSourceControlResponse: SourceControl & object

Contains response data for the getSourceControl operation.

GetSubscriptionDeploymentLocationsResponse

GetSubscriptionDeploymentLocationsResponse: DeploymentLocations & object

Contains response data for the getSubscriptionDeploymentLocations operation.

HostNameType

HostNameType: "Verified" | "Managed"

Defines values for HostNameType. Possible values include: 'Verified', 'Managed'

readonly
enum: {string}

HostType

HostType: "Standard" | "Repository"

Defines values for HostType. Possible values include: 'Standard', 'Repository'

readonly
enum: {string}

HostingEnvironmentStatus

HostingEnvironmentStatus: "Preparing" | "Ready" | "Scaling" | "Deleting"

Defines values for HostingEnvironmentStatus. Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting'

readonly
enum: {string}

InAvailabilityReasonType

InAvailabilityReasonType: "Invalid" | "AlreadyExists"

Defines values for InAvailabilityReasonType. Possible values include: 'Invalid', 'AlreadyExists'

readonly
enum: {string}

InternalLoadBalancingMode

InternalLoadBalancingMode: "None" | "Web" | "Publishing"

Defines values for InternalLoadBalancingMode. Possible values include: 'None', 'Web', 'Publishing'

readonly
enum: {string}

IpFilterTag

IpFilterTag: "Default" | "XffProxy"

Defines values for IpFilterTag. Possible values include: 'Default', 'XffProxy'

readonly
enum: {string}

IssueType

Defines values for IssueType. Possible values include: 'ServiceIncident', 'AppDeployment', 'AppCrash', 'RuntimeIssueDetected', 'AseDeployment', 'UserIssue', 'PlatformIssue', 'Other'

readonly
enum: {string}

KeyVaultSecretStatus

Defines values for KeyVaultSecretStatus. Possible values include: 'Initialized', 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey', 'Unknown'

readonly
enum: {string}

ListBillingMetersNextResponse

ListBillingMetersNextResponse: BillingMeterCollection & object

Contains response data for the listBillingMetersNext operation.

ListBillingMetersResponse

ListBillingMetersResponse: BillingMeterCollection & object

Contains response data for the listBillingMeters operation.

ListGeoRegionsNextResponse

ListGeoRegionsNextResponse: GeoRegionCollection & object

Contains response data for the listGeoRegionsNext operation.

ListGeoRegionsResponse

ListGeoRegionsResponse: GeoRegionCollection & object

Contains response data for the listGeoRegions operation.

ListPremierAddOnOffersNextResponse

ListPremierAddOnOffersNextResponse: PremierAddOnOfferCollection & object

Contains response data for the listPremierAddOnOffersNext operation.

ListPremierAddOnOffersResponse

ListPremierAddOnOffersResponse: PremierAddOnOfferCollection & object

Contains response data for the listPremierAddOnOffers operation.

ListSiteIdentifiersAssignedToHostNameNextResponse

ListSiteIdentifiersAssignedToHostNameNextResponse: IdentifierCollection & object

Contains response data for the listSiteIdentifiersAssignedToHostNameNext operation.

ListSiteIdentifiersAssignedToHostNameResponse

ListSiteIdentifiersAssignedToHostNameResponse: IdentifierCollection & object

Contains response data for the listSiteIdentifiersAssignedToHostName operation.

ListSkusResponse

ListSkusResponse: SkuInfos & object

Contains response data for the listSkus operation.

ListSourceControlsNextResponse

ListSourceControlsNextResponse: SourceControlCollection & object

Contains response data for the listSourceControlsNext operation.

ListSourceControlsResponse

ListSourceControlsResponse: SourceControlCollection & object

Contains response data for the listSourceControls operation.

LogLevel

LogLevel: "Off" | "Verbose" | "Information" | "Warning" | "Error"

Defines values for LogLevel. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'

readonly
enum: {string}

MSDeployLogEntryType

MSDeployLogEntryType: "Message" | "Warning" | "Error"

Defines values for MSDeployLogEntryType. Possible values include: 'Message', 'Warning', 'Error'

readonly
enum: {string}

MSDeployProvisioningState

MSDeployProvisioningState: "accepted" | "running" | "succeeded" | "failed" | "canceled"

Defines values for MSDeployProvisioningState. Possible values include: 'accepted', 'running', 'succeeded', 'failed', 'canceled'

readonly
enum: {string}

ManagedPipelineMode

ManagedPipelineMode: "Integrated" | "Classic"

Defines values for ManagedPipelineMode. Possible values include: 'Integrated', 'Classic'

readonly
enum: {string}

ManagedServiceIdentityType

ManagedServiceIdentityType: "SystemAssigned" | "UserAssigned"

Defines values for ManagedServiceIdentityType. Possible values include: 'SystemAssigned', 'UserAssigned'

readonly
enum: {string}

MySqlMigrationType

MySqlMigrationType: "LocalToRemote" | "RemoteToLocal"

Defines values for MySqlMigrationType. Possible values include: 'LocalToRemote', 'RemoteToLocal'

readonly
enum: {string}

NotificationLevel

NotificationLevel: "Critical" | "Warning" | "Information" | "NonUrgentSuggestion"

Defines values for NotificationLevel. Possible values include: 'Critical', 'Warning', 'Information', 'NonUrgentSuggestion'

readonly
enum: {string}

OperationStatus

OperationStatus: "InProgress" | "Failed" | "Succeeded" | "TimedOut" | "Created"

Defines values for OperationStatus. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created'

readonly
enum: {string}

OsTypeSelected

OsTypeSelected: "Windows" | "Linux" | "WindowsFunctions" | "LinuxFunctions"

Defines values for OsTypeSelected. Possible values include: 'Windows', 'Linux', 'WindowsFunctions', 'LinuxFunctions'

readonly
enum: {string}

OsTypeSelected1

OsTypeSelected1: "Windows" | "Linux" | "WindowsFunctions" | "LinuxFunctions"

Defines values for OsTypeSelected1. Possible values include: 'Windows', 'Linux', 'WindowsFunctions', 'LinuxFunctions'

readonly
enum: {string}

ProviderGetAvailableStacksNextResponse

ProviderGetAvailableStacksNextResponse: ApplicationStackCollection & object

Contains response data for the getAvailableStacksNext operation.

ProviderGetAvailableStacksOnPremNextResponse

ProviderGetAvailableStacksOnPremNextResponse: ApplicationStackCollection & object

Contains response data for the getAvailableStacksOnPremNext operation.

ProviderGetAvailableStacksOnPremResponse

ProviderGetAvailableStacksOnPremResponse: ApplicationStackCollection & object

Contains response data for the getAvailableStacksOnPrem operation.

ProviderGetAvailableStacksResponse

ProviderGetAvailableStacksResponse: ApplicationStackCollection & object

Contains response data for the getAvailableStacks operation.

ProviderListOperationsNextResponse

ProviderListOperationsNextResponse: CsmOperationCollection & object

Contains response data for the listOperationsNext operation.

ProviderListOperationsResponse

ProviderListOperationsResponse: CsmOperationCollection & object

Contains response data for the listOperations operation.

ProvisioningState

ProvisioningState: "Succeeded" | "Failed" | "Canceled" | "InProgress" | "Deleting"

Defines values for ProvisioningState. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting'

readonly
enum: {string}

PublicCertificateLocation

PublicCertificateLocation: "CurrentUserMy" | "LocalMachineMy" | "Unknown"

Defines values for PublicCertificateLocation. Possible values include: 'CurrentUserMy', 'LocalMachineMy', 'Unknown'

readonly
enum: {string}

PublishingProfileFormat

PublishingProfileFormat: "FileZilla3" | "WebDeploy" | "Ftp"

Defines values for PublishingProfileFormat. Possible values include: 'FileZilla3', 'WebDeploy', 'Ftp'

readonly
enum: {string}

RecommendationsGetRuleDetailsByWebAppResponse

RecommendationsGetRuleDetailsByWebAppResponse: RecommendationRule & object

Contains response data for the getRuleDetailsByWebApp operation.

RecommendationsListHistoryForWebAppNextResponse

RecommendationsListHistoryForWebAppNextResponse: RecommendationCollection & object

Contains response data for the listHistoryForWebAppNext operation.

RecommendationsListHistoryForWebAppResponse

RecommendationsListHistoryForWebAppResponse: RecommendationCollection & object

Contains response data for the listHistoryForWebApp operation.

RecommendationsListNextResponse

RecommendationsListNextResponse: RecommendationCollection & object

Contains response data for the listNext operation.

RecommendationsListRecommendedRulesForWebAppNextResponse

RecommendationsListRecommendedRulesForWebAppNextResponse: RecommendationCollection & object

Contains response data for the listRecommendedRulesForWebAppNext operation.

RecommendationsListRecommendedRulesForWebAppResponse

RecommendationsListRecommendedRulesForWebAppResponse: RecommendationCollection & object

Contains response data for the listRecommendedRulesForWebApp operation.

RecommendationsListResponse

RecommendationsListResponse: RecommendationCollection & object

Contains response data for the list operation.

RenderingType

RenderingType: "NoGraph" | "Table" | "TimeSeries" | "TimeSeriesPerInstance"

Defines values for RenderingType. Possible values include: 'NoGraph', 'Table', 'TimeSeries', 'TimeSeriesPerInstance'

readonly
enum: {string}

ResourceHealthMetadataGetBySiteResponse

ResourceHealthMetadataGetBySiteResponse: ResourceHealthMetadata & object

Contains response data for the getBySite operation.

ResourceHealthMetadataGetBySiteSlotResponse

ResourceHealthMetadataGetBySiteSlotResponse: ResourceHealthMetadata & object

Contains response data for the getBySiteSlot operation.

ResourceHealthMetadataListByResourceGroupNextResponse

ResourceHealthMetadataListByResourceGroupNextResponse: ResourceHealthMetadataCollection & object

Contains response data for the listByResourceGroupNext operation.

ResourceHealthMetadataListByResourceGroupResponse

ResourceHealthMetadataListByResourceGroupResponse: ResourceHealthMetadataCollection & object

Contains response data for the listByResourceGroup operation.

ResourceHealthMetadataListBySiteNextResponse

ResourceHealthMetadataListBySiteNextResponse: ResourceHealthMetadataCollection & object

Contains response data for the listBySiteNext operation.

ResourceHealthMetadataListBySiteResponse

ResourceHealthMetadataListBySiteResponse: ResourceHealthMetadataCollection & object

Contains response data for the listBySite operation.

ResourceHealthMetadataListBySiteSlotNextResponse

ResourceHealthMetadataListBySiteSlotNextResponse: ResourceHealthMetadataCollection & object

Contains response data for the listBySiteSlotNext operation.

ResourceHealthMetadataListBySiteSlotResponse

ResourceHealthMetadataListBySiteSlotResponse: ResourceHealthMetadataCollection & object

Contains response data for the listBySiteSlot operation.

ResourceHealthMetadataListNextResponse

ResourceHealthMetadataListNextResponse: ResourceHealthMetadataCollection & object

Contains response data for the listNext operation.

ResourceHealthMetadataListResponse

ResourceHealthMetadataListResponse: ResourceHealthMetadataCollection & object

Contains response data for the list operation.

ResourceScopeType

ResourceScopeType: "ServerFarm" | "Subscription" | "WebSite"

Defines values for ResourceScopeType. Possible values include: 'ServerFarm', 'Subscription', 'WebSite'

readonly
enum: {string}

RouteType

RouteType: "DEFAULT" | "INHERITED" | "STATIC"

Defines values for RouteType. Possible values include: 'DEFAULT', 'INHERITED', 'STATIC'

readonly
enum: {string}

ScmType

Defines values for ScmType. Possible values include: 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive', 'VSO'

readonly
enum: {string}

SiteAvailabilityState

SiteAvailabilityState: "Normal" | "Limited" | "DisasterRecoveryMode"

Defines values for SiteAvailabilityState. Possible values include: 'Normal', 'Limited', 'DisasterRecoveryMode'

readonly
enum: {string}

SiteExtensionType

SiteExtensionType: "Gallery" | "WebRoot"

Defines values for SiteExtensionType. Possible values include: 'Gallery', 'WebRoot'

readonly
enum: {string}

SiteLoadBalancing

SiteLoadBalancing: "WeightedRoundRobin" | "LeastRequests" | "LeastResponseTime" | "WeightedTotalTraffic" | "RequestHash"

Defines values for SiteLoadBalancing. Possible values include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash'

readonly
enum: {string}

SkuName

Defines values for SkuName. Possible values include: 'Free', 'Shared', 'Basic', 'Standard', 'Premium', 'Dynamic', 'Isolated', 'PremiumV2', 'ElasticPremium', 'ElasticIsolated'

readonly
enum: {string}

SolutionType

SolutionType: "QuickSolution" | "DeepInvestigation" | "BestPractices"

Defines values for SolutionType. Possible values include: 'QuickSolution', 'DeepInvestigation', 'BestPractices'

readonly
enum: {string}

SslState

SslState: "Disabled" | "SniEnabled" | "IpBasedEnabled"

Defines values for SslState. Possible values include: 'Disabled', 'SniEnabled', 'IpBasedEnabled'

readonly
enum: {string}

StatusOptions

StatusOptions: "Ready" | "Pending" | "Creating"

Defines values for StatusOptions. Possible values include: 'Ready', 'Pending', 'Creating'

readonly
enum: {string}

SupportedTlsVersions

SupportedTlsVersions: "1.0" | "1.1" | "1.2"

Defines values for SupportedTlsVersions. Possible values include: '1.0', '1.1', '1.2'

readonly
enum: {string}

TopLevelDomainsGetResponse

TopLevelDomainsGetResponse: TopLevelDomain & object

Contains response data for the get operation.

TopLevelDomainsListAgreementsNextResponse

TopLevelDomainsListAgreementsNextResponse: TldLegalAgreementCollection & object

Contains response data for the listAgreementsNext operation.

TopLevelDomainsListAgreementsResponse

TopLevelDomainsListAgreementsResponse: TldLegalAgreementCollection & object

Contains response data for the listAgreements operation.

TopLevelDomainsListNextResponse

TopLevelDomainsListNextResponse: TopLevelDomainCollection & object

Contains response data for the listNext operation.

TopLevelDomainsListResponse

TopLevelDomainsListResponse: TopLevelDomainCollection & object

Contains response data for the list operation.

TriggeredWebJobStatus

TriggeredWebJobStatus: "Success" | "Failed" | "Error"

Defines values for TriggeredWebJobStatus. Possible values include: 'Success', 'Failed', 'Error'

readonly
enum: {string}

UnauthenticatedClientAction

UnauthenticatedClientAction: "RedirectToLoginPage" | "AllowAnonymous"

Defines values for UnauthenticatedClientAction. Possible values include: 'RedirectToLoginPage', 'AllowAnonymous'

readonly
enum: {string}

UpdatePublishingUserResponse

UpdatePublishingUserResponse: User & object

Contains response data for the updatePublishingUser operation.

UpdateSourceControlResponse

UpdateSourceControlResponse: SourceControl & object

Contains response data for the updateSourceControl operation.

UsageState

UsageState: "Normal" | "Exceeded"

Defines values for UsageState. Possible values include: 'Normal', 'Exceeded'

readonly
enum: {string}

ValidateResourceTypes

ValidateResourceTypes: "ServerFarm" | "Site"

Defines values for ValidateResourceTypes. Possible values include: 'ServerFarm', 'Site'

readonly
enum: {string}

ValidateResponse2

ValidateResponse2: ValidateResponse & object

Contains response data for the validate operation.

VerifyHostingEnvironmentVnetResponse

VerifyHostingEnvironmentVnetResponse: VnetValidationFailureDetails & object

Contains response data for the verifyHostingEnvironmentVnet operation.

WebAppsAddPremierAddOnResponse

WebAppsAddPremierAddOnResponse: PremierAddOn & object

Contains response data for the addPremierAddOn operation.

WebAppsAddPremierAddOnSlotResponse

WebAppsAddPremierAddOnSlotResponse: PremierAddOn & object

Contains response data for the addPremierAddOnSlot operation.

WebAppsAnalyzeCustomHostnameResponse

WebAppsAnalyzeCustomHostnameResponse: CustomHostnameAnalysisResult & object

Contains response data for the analyzeCustomHostname operation.

WebAppsAnalyzeCustomHostnameSlotResponse

WebAppsAnalyzeCustomHostnameSlotResponse: CustomHostnameAnalysisResult & object

Contains response data for the analyzeCustomHostnameSlot operation.

WebAppsBackupResponse

WebAppsBackupResponse: BackupItem & object

Contains response data for the backup operation.

WebAppsBackupSlotResponse

WebAppsBackupSlotResponse: BackupItem & object

Contains response data for the backupSlot operation.

WebAppsBeginCreateFunctionResponse

WebAppsBeginCreateFunctionResponse: FunctionEnvelope & object

Contains response data for the beginCreateFunction operation.

WebAppsBeginCreateInstanceFunctionSlotResponse

WebAppsBeginCreateInstanceFunctionSlotResponse: FunctionEnvelope & object

Contains response data for the beginCreateInstanceFunctionSlot operation.

WebAppsBeginCreateInstanceMSDeployOperationResponse

WebAppsBeginCreateInstanceMSDeployOperationResponse: MSDeployStatus & object

Contains response data for the beginCreateInstanceMSDeployOperation operation.

WebAppsBeginCreateInstanceMSDeployOperationSlotResponse

WebAppsBeginCreateInstanceMSDeployOperationSlotResponse: MSDeployStatus & object

Contains response data for the beginCreateInstanceMSDeployOperationSlot operation.

WebAppsBeginCreateMSDeployOperationResponse

WebAppsBeginCreateMSDeployOperationResponse: MSDeployStatus & object

Contains response data for the beginCreateMSDeployOperation operation.

WebAppsBeginCreateMSDeployOperationSlotResponse

WebAppsBeginCreateMSDeployOperationSlotResponse: MSDeployStatus & object

Contains response data for the beginCreateMSDeployOperationSlot operation.

WebAppsBeginCreateOrUpdateResponse

WebAppsBeginCreateOrUpdateResponse: Site & object

Contains response data for the beginCreateOrUpdate operation.

WebAppsBeginCreateOrUpdateSlotResponse

WebAppsBeginCreateOrUpdateSlotResponse: Site & object

Contains response data for the beginCreateOrUpdateSlot operation.

WebAppsBeginCreateOrUpdateSourceControlResponse

WebAppsBeginCreateOrUpdateSourceControlResponse: SiteSourceControl & object

Contains response data for the beginCreateOrUpdateSourceControl operation.

WebAppsBeginCreateOrUpdateSourceControlSlotResponse

WebAppsBeginCreateOrUpdateSourceControlSlotResponse: SiteSourceControl & object

Contains response data for the beginCreateOrUpdateSourceControlSlot operation.

WebAppsBeginInstallSiteExtensionResponse

WebAppsBeginInstallSiteExtensionResponse: SiteExtensionInfo & object

Contains response data for the beginInstallSiteExtension operation.

WebAppsBeginInstallSiteExtensionSlotResponse

WebAppsBeginInstallSiteExtensionSlotResponse: SiteExtensionInfo & object

Contains response data for the beginInstallSiteExtensionSlot operation.

WebAppsBeginListPublishingCredentialsResponse

WebAppsBeginListPublishingCredentialsResponse: User & object

Contains response data for the beginListPublishingCredentials operation.

WebAppsBeginListPublishingCredentialsSlotResponse

WebAppsBeginListPublishingCredentialsSlotResponse: User & object

Contains response data for the beginListPublishingCredentialsSlot operation.

WebAppsBeginMigrateMySqlResponse

WebAppsBeginMigrateMySqlResponse: Operation & object

Contains response data for the beginMigrateMySql operation.

WebAppsBeginMigrateStorageResponse

WebAppsBeginMigrateStorageResponse: StorageMigrationResponse & object

Contains response data for the beginMigrateStorage operation.

WebAppsBeginStartNetworkTraceResponse

WebAppsBeginStartNetworkTraceResponse: Array<NetworkTrace> & object

Contains response data for the beginStartNetworkTrace operation.

WebAppsBeginStartNetworkTraceSlotResponse

WebAppsBeginStartNetworkTraceSlotResponse: Array<NetworkTrace> & object

Contains response data for the beginStartNetworkTraceSlot operation.

WebAppsBeginStartWebSiteNetworkTraceOperationResponse

WebAppsBeginStartWebSiteNetworkTraceOperationResponse: Array<NetworkTrace> & object

Contains response data for the beginStartWebSiteNetworkTraceOperation operation.

WebAppsBeginStartWebSiteNetworkTraceOperationSlotResponse

WebAppsBeginStartWebSiteNetworkTraceOperationSlotResponse: Array<NetworkTrace> & object

Contains response data for the beginStartWebSiteNetworkTraceOperationSlot operation.

WebAppsCreateDeploymentResponse

WebAppsCreateDeploymentResponse: Deployment & object

Contains response data for the createDeployment operation.

WebAppsCreateDeploymentSlotResponse

WebAppsCreateDeploymentSlotResponse: Deployment & object

Contains response data for the createDeploymentSlot operation.

WebAppsCreateFunctionResponse

WebAppsCreateFunctionResponse: FunctionEnvelope & object

Contains response data for the createFunction operation.

WebAppsCreateInstanceFunctionSlotResponse

WebAppsCreateInstanceFunctionSlotResponse: FunctionEnvelope & object

Contains response data for the createInstanceFunctionSlot operation.

WebAppsCreateInstanceMSDeployOperationResponse

WebAppsCreateInstanceMSDeployOperationResponse: MSDeployStatus & object

Contains response data for the createInstanceMSDeployOperation operation.

WebAppsCreateInstanceMSDeployOperationSlotResponse

WebAppsCreateInstanceMSDeployOperationSlotResponse: MSDeployStatus & object

Contains response data for the createInstanceMSDeployOperationSlot operation.

WebAppsCreateMSDeployOperationResponse

WebAppsCreateMSDeployOperationResponse: MSDeployStatus & object

Contains response data for the createMSDeployOperation operation.

WebAppsCreateMSDeployOperationSlotResponse

WebAppsCreateMSDeployOperationSlotResponse: MSDeployStatus & object

Contains response data for the createMSDeployOperationSlot operation.

WebAppsCreateOrUpdateConfigurationResponse

WebAppsCreateOrUpdateConfigurationResponse: SiteConfigResource & object

Contains response data for the createOrUpdateConfiguration operation.

WebAppsCreateOrUpdateConfigurationSlotResponse

WebAppsCreateOrUpdateConfigurationSlotResponse: SiteConfigResource & object

Contains response data for the createOrUpdateConfigurationSlot operation.

WebAppsCreateOrUpdateDomainOwnershipIdentifierResponse

WebAppsCreateOrUpdateDomainOwnershipIdentifierResponse: Identifier & object

Contains response data for the createOrUpdateDomainOwnershipIdentifier operation.

WebAppsCreateOrUpdateDomainOwnershipIdentifierSlotResponse

WebAppsCreateOrUpdateDomainOwnershipIdentifierSlotResponse: Identifier & object

Contains response data for the createOrUpdateDomainOwnershipIdentifierSlot operation.

WebAppsCreateOrUpdateHostNameBindingResponse

WebAppsCreateOrUpdateHostNameBindingResponse: HostNameBinding & object

Contains response data for the createOrUpdateHostNameBinding operation.

WebAppsCreateOrUpdateHostNameBindingSlotResponse

WebAppsCreateOrUpdateHostNameBindingSlotResponse: HostNameBinding & object

Contains response data for the createOrUpdateHostNameBindingSlot operation.

WebAppsCreateOrUpdateHybridConnectionResponse

WebAppsCreateOrUpdateHybridConnectionResponse: HybridConnection & object

Contains response data for the createOrUpdateHybridConnection operation.

WebAppsCreateOrUpdateHybridConnectionSlotResponse

WebAppsCreateOrUpdateHybridConnectionSlotResponse: HybridConnection & object

Contains response data for the createOrUpdateHybridConnectionSlot operation.

WebAppsCreateOrUpdatePublicCertificateResponse

WebAppsCreateOrUpdatePublicCertificateResponse: PublicCertificate & object

Contains response data for the createOrUpdatePublicCertificate operation.

WebAppsCreateOrUpdatePublicCertificateSlotResponse

WebAppsCreateOrUpdatePublicCertificateSlotResponse: PublicCertificate & object

Contains response data for the createOrUpdatePublicCertificateSlot operation.

WebAppsCreateOrUpdateRelayServiceConnectionResponse

WebAppsCreateOrUpdateRelayServiceConnectionResponse: RelayServiceConnectionEntity & object

Contains response data for the createOrUpdateRelayServiceConnection operation.

WebAppsCreateOrUpdateRelayServiceConnectionSlotResponse

WebAppsCreateOrUpdateRelayServiceConnectionSlotResponse: RelayServiceConnectionEntity & object

Contains response data for the createOrUpdateRelayServiceConnectionSlot operation.

WebAppsCreateOrUpdateResponse

WebAppsCreateOrUpdateResponse: Site & object

Contains response data for the createOrUpdate operation.

WebAppsCreateOrUpdateSlotResponse

WebAppsCreateOrUpdateSlotResponse: Site & object

Contains response data for the createOrUpdateSlot operation.

WebAppsCreateOrUpdateSourceControlResponse

WebAppsCreateOrUpdateSourceControlResponse: SiteSourceControl & object

Contains response data for the createOrUpdateSourceControl operation.

WebAppsCreateOrUpdateSourceControlSlotResponse

WebAppsCreateOrUpdateSourceControlSlotResponse: SiteSourceControl & object

Contains response data for the createOrUpdateSourceControlSlot operation.

WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionResponse

WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionResponse: SwiftVirtualNetwork & object

Contains response data for the createOrUpdateSwiftVirtualNetworkConnection operation.

WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionSlotResponse

WebAppsCreateOrUpdateSwiftVirtualNetworkConnectionSlotResponse: SwiftVirtualNetwork & object

Contains response data for the createOrUpdateSwiftVirtualNetworkConnectionSlot operation.

WebAppsCreateOrUpdateVnetConnectionGatewayResponse

WebAppsCreateOrUpdateVnetConnectionGatewayResponse: VnetGateway & object

Contains response data for the createOrUpdateVnetConnectionGateway operation.

WebAppsCreateOrUpdateVnetConnectionGatewaySlotResponse

WebAppsCreateOrUpdateVnetConnectionGatewaySlotResponse: VnetGateway & object

Contains response data for the createOrUpdateVnetConnectionGatewaySlot operation.

WebAppsCreateOrUpdateVnetConnectionResponse

WebAppsCreateOrUpdateVnetConnectionResponse: VnetInfo & object

Contains response data for the createOrUpdateVnetConnection operation.

WebAppsCreateOrUpdateVnetConnectionSlotResponse

WebAppsCreateOrUpdateVnetConnectionSlotResponse: VnetInfo & object

Contains response data for the createOrUpdateVnetConnectionSlot operation.

WebAppsDiscoverBackupResponse

WebAppsDiscoverBackupResponse: RestoreRequest & object

Contains response data for the discoverBackup operation.

WebAppsDiscoverBackupSlotResponse

WebAppsDiscoverBackupSlotResponse: RestoreRequest & object

Contains response data for the discoverBackupSlot operation.

WebAppsGetAuthSettingsResponse

WebAppsGetAuthSettingsResponse: SiteAuthSettings & object

Contains response data for the getAuthSettings operation.

WebAppsGetAuthSettingsSlotResponse

WebAppsGetAuthSettingsSlotResponse: SiteAuthSettings & object

Contains response data for the getAuthSettingsSlot operation.

WebAppsGetBackupConfigurationResponse

WebAppsGetBackupConfigurationResponse: BackupRequest & object

Contains response data for the getBackupConfiguration operation.

WebAppsGetBackupConfigurationSlotResponse

WebAppsGetBackupConfigurationSlotResponse: BackupRequest & object

Contains response data for the getBackupConfigurationSlot operation.

WebAppsGetBackupStatusResponse

WebAppsGetBackupStatusResponse: BackupItem & object

Contains response data for the getBackupStatus operation.

WebAppsGetBackupStatusSlotResponse

WebAppsGetBackupStatusSlotResponse: BackupItem & object

Contains response data for the getBackupStatusSlot operation.

WebAppsGetConfigurationResponse

WebAppsGetConfigurationResponse: SiteConfigResource & object

Contains response data for the getConfiguration operation.

WebAppsGetConfigurationSlotResponse

WebAppsGetConfigurationSlotResponse: SiteConfigResource & object

Contains response data for the getConfigurationSlot operation.

WebAppsGetConfigurationSnapshotResponse

WebAppsGetConfigurationSnapshotResponse: SiteConfigResource & object

Contains response data for the getConfigurationSnapshot operation.

WebAppsGetConfigurationSnapshotSlotResponse

WebAppsGetConfigurationSnapshotSlotResponse: SiteConfigResource & object

Contains response data for the getConfigurationSnapshotSlot operation.

WebAppsGetContainerLogsZipResponse

WebAppsGetContainerLogsZipResponse: object

Contains response data for the getContainerLogsZip operation.

Type declaration

WebAppsGetContainerLogsZipSlotResponse

WebAppsGetContainerLogsZipSlotResponse: object

Contains response data for the getContainerLogsZipSlot operation.

Type declaration

WebAppsGetContinuousWebJobResponse

WebAppsGetContinuousWebJobResponse: ContinuousWebJob & object

Contains response data for the getContinuousWebJob operation.

WebAppsGetContinuousWebJobSlotResponse

WebAppsGetContinuousWebJobSlotResponse: ContinuousWebJob & object

Contains response data for the getContinuousWebJobSlot operation.

WebAppsGetDeploymentResponse

WebAppsGetDeploymentResponse: Deployment & object

Contains response data for the getDeployment operation.

WebAppsGetDeploymentSlotResponse

WebAppsGetDeploymentSlotResponse: Deployment & object

Contains response data for the getDeploymentSlot operation.

WebAppsGetDiagnosticLogsConfigurationResponse

WebAppsGetDiagnosticLogsConfigurationResponse: SiteLogsConfig & object

Contains response data for the getDiagnosticLogsConfiguration operation.

WebAppsGetDiagnosticLogsConfigurationSlotResponse

WebAppsGetDiagnosticLogsConfigurationSlotResponse: SiteLogsConfig & object

Contains response data for the getDiagnosticLogsConfigurationSlot operation.

WebAppsGetDomainOwnershipIdentifierResponse

WebAppsGetDomainOwnershipIdentifierResponse: Identifier & object

Contains response data for the getDomainOwnershipIdentifier operation.

WebAppsGetDomainOwnershipIdentifierSlotResponse

WebAppsGetDomainOwnershipIdentifierSlotResponse: Identifier & object

Contains response data for the getDomainOwnershipIdentifierSlot operation.

WebAppsGetFunctionResponse

WebAppsGetFunctionResponse: FunctionEnvelope & object

Contains response data for the getFunction operation.

WebAppsGetFunctionsAdminTokenResponse

WebAppsGetFunctionsAdminTokenResponse: object

Contains response data for the getFunctionsAdminToken operation.

Type declaration

WebAppsGetFunctionsAdminTokenSlotResponse

WebAppsGetFunctionsAdminTokenSlotResponse: object

Contains response data for the getFunctionsAdminTokenSlot operation.

Type declaration

WebAppsGetHostNameBindingResponse

WebAppsGetHostNameBindingResponse: HostNameBinding & object

Contains response data for the getHostNameBinding operation.

WebAppsGetHostNameBindingSlotResponse

WebAppsGetHostNameBindingSlotResponse: HostNameBinding & object

Contains response data for the getHostNameBindingSlot operation.

WebAppsGetHybridConnectionResponse

WebAppsGetHybridConnectionResponse: HybridConnection & object

Contains response data for the getHybridConnection operation.

WebAppsGetHybridConnectionSlotResponse

WebAppsGetHybridConnectionSlotResponse: HybridConnection & object

Contains response data for the getHybridConnectionSlot operation.

WebAppsGetInstanceFunctionSlotResponse

WebAppsGetInstanceFunctionSlotResponse: FunctionEnvelope & object

Contains response data for the getInstanceFunctionSlot operation.

WebAppsGetInstanceMSDeployLogResponse

WebAppsGetInstanceMSDeployLogResponse: MSDeployLog & object

Contains response data for the getInstanceMSDeployLog operation.

WebAppsGetInstanceMSDeployLogSlotResponse

WebAppsGetInstanceMSDeployLogSlotResponse: MSDeployLog & object

Contains response data for the getInstanceMSDeployLogSlot operation.

WebAppsGetInstanceMsDeployStatusResponse

WebAppsGetInstanceMsDeployStatusResponse: MSDeployStatus & object

Contains response data for the getInstanceMsDeployStatus operation.

WebAppsGetInstanceMsDeployStatusSlotResponse

WebAppsGetInstanceMsDeployStatusSlotResponse: MSDeployStatus & object

Contains response data for the getInstanceMsDeployStatusSlot operation.

WebAppsGetInstanceProcessDumpResponse

WebAppsGetInstanceProcessDumpResponse: object

Contains response data for the getInstanceProcessDump operation.

Type declaration

WebAppsGetInstanceProcessDumpSlotResponse

WebAppsGetInstanceProcessDumpSlotResponse: object

Contains response data for the getInstanceProcessDumpSlot operation.

Type declaration

WebAppsGetInstanceProcessModuleResponse

WebAppsGetInstanceProcessModuleResponse: ProcessModuleInfo & object

Contains response data for the getInstanceProcessModule operation.

WebAppsGetInstanceProcessModuleSlotResponse

WebAppsGetInstanceProcessModuleSlotResponse: ProcessModuleInfo & object

Contains response data for the getInstanceProcessModuleSlot operation.

WebAppsGetInstanceProcessResponse

WebAppsGetInstanceProcessResponse: ProcessInfo & object

Contains response data for the getInstanceProcess operation.

WebAppsGetInstanceProcessSlotResponse

WebAppsGetInstanceProcessSlotResponse: ProcessInfo & object

Contains response data for the getInstanceProcessSlot operation.

WebAppsGetInstanceProcessThreadResponse

WebAppsGetInstanceProcessThreadResponse: ProcessThreadInfo & object

Contains response data for the getInstanceProcessThread operation.

WebAppsGetInstanceProcessThreadSlotResponse

WebAppsGetInstanceProcessThreadSlotResponse: ProcessThreadInfo & object

Contains response data for the getInstanceProcessThreadSlot operation.

WebAppsGetMSDeployLogResponse

WebAppsGetMSDeployLogResponse: MSDeployLog & object

Contains response data for the getMSDeployLog operation.

WebAppsGetMSDeployLogSlotResponse

WebAppsGetMSDeployLogSlotResponse: MSDeployLog & object

Contains response data for the getMSDeployLogSlot operation.

WebAppsGetMSDeployStatusResponse

WebAppsGetMSDeployStatusResponse: MSDeployStatus & object

Contains response data for the getMSDeployStatus operation.

WebAppsGetMSDeployStatusSlotResponse

WebAppsGetMSDeployStatusSlotResponse: MSDeployStatus & object

Contains response data for the getMSDeployStatusSlot operation.

WebAppsGetMigrateMySqlStatusResponse

WebAppsGetMigrateMySqlStatusResponse: MigrateMySqlStatus & object

Contains response data for the getMigrateMySqlStatus operation.

WebAppsGetMigrateMySqlStatusSlotResponse

WebAppsGetMigrateMySqlStatusSlotResponse: MigrateMySqlStatus & object

Contains response data for the getMigrateMySqlStatusSlot operation.

WebAppsGetNetworkTraceOperationResponse

WebAppsGetNetworkTraceOperationResponse: Array<NetworkTrace> & object

Contains response data for the getNetworkTraceOperation operation.

WebAppsGetNetworkTraceOperationSlotResponse

WebAppsGetNetworkTraceOperationSlotResponse: Array<NetworkTrace> & object

Contains response data for the getNetworkTraceOperationSlot operation.

WebAppsGetNetworkTraceOperationSlotV2Response

WebAppsGetNetworkTraceOperationSlotV2Response: Array<NetworkTrace> & object

Contains response data for the getNetworkTraceOperationSlotV2 operation.

WebAppsGetNetworkTraceOperationV2Response

WebAppsGetNetworkTraceOperationV2Response: Array<NetworkTrace> & object

Contains response data for the getNetworkTraceOperationV2 operation.

WebAppsGetNetworkTracesResponse

WebAppsGetNetworkTracesResponse: Array<NetworkTrace> & object

Contains response data for the getNetworkTraces operation.

WebAppsGetNetworkTracesSlotResponse

WebAppsGetNetworkTracesSlotResponse: Array<NetworkTrace> & object

Contains response data for the getNetworkTracesSlot operation.

WebAppsGetNetworkTracesSlotV2Response

WebAppsGetNetworkTracesSlotV2Response: Array<NetworkTrace> & object

Contains response data for the getNetworkTracesSlotV2 operation.

WebAppsGetNetworkTracesV2Response

WebAppsGetNetworkTracesV2Response: Array<NetworkTrace> & object

Contains response data for the getNetworkTracesV2 operation.

WebAppsGetPremierAddOnResponse

WebAppsGetPremierAddOnResponse: PremierAddOn & object

Contains response data for the getPremierAddOn operation.

WebAppsGetPremierAddOnSlotResponse

WebAppsGetPremierAddOnSlotResponse: PremierAddOn & object

Contains response data for the getPremierAddOnSlot operation.

WebAppsGetPrivateAccessResponse

WebAppsGetPrivateAccessResponse: PrivateAccess & object

Contains response data for the getPrivateAccess operation.

WebAppsGetPrivateAccessSlotResponse

WebAppsGetPrivateAccessSlotResponse: PrivateAccess & object

Contains response data for the getPrivateAccessSlot operation.

WebAppsGetProcessDumpResponse

WebAppsGetProcessDumpResponse: object

Contains response data for the getProcessDump operation.

Type declaration

WebAppsGetProcessDumpSlotResponse

WebAppsGetProcessDumpSlotResponse: object

Contains response data for the getProcessDumpSlot operation.

Type declaration

WebAppsGetProcessModuleResponse

WebAppsGetProcessModuleResponse: ProcessModuleInfo & object

Contains response data for the getProcessModule operation.

WebAppsGetProcessModuleSlotResponse

WebAppsGetProcessModuleSlotResponse: ProcessModuleInfo & object

Contains response data for the getProcessModuleSlot operation.

WebAppsGetProcessResponse

WebAppsGetProcessResponse: ProcessInfo & object

Contains response data for the getProcess operation.

WebAppsGetProcessSlotResponse

WebAppsGetProcessSlotResponse: ProcessInfo & object

Contains response data for the getProcessSlot operation.

WebAppsGetProcessThreadResponse

WebAppsGetProcessThreadResponse: ProcessThreadInfo & object

Contains response data for the getProcessThread operation.

WebAppsGetProcessThreadSlotResponse

WebAppsGetProcessThreadSlotResponse: ProcessThreadInfo & object

Contains response data for the getProcessThreadSlot operation.

WebAppsGetPublicCertificateResponse

WebAppsGetPublicCertificateResponse: PublicCertificate & object

Contains response data for the getPublicCertificate operation.

WebAppsGetPublicCertificateSlotResponse

WebAppsGetPublicCertificateSlotResponse: PublicCertificate & object

Contains response data for the getPublicCertificateSlot operation.

WebAppsGetRelayServiceConnectionResponse

WebAppsGetRelayServiceConnectionResponse: RelayServiceConnectionEntity & object

Contains response data for the getRelayServiceConnection operation.

WebAppsGetRelayServiceConnectionSlotResponse

WebAppsGetRelayServiceConnectionSlotResponse: RelayServiceConnectionEntity & object

Contains response data for the getRelayServiceConnectionSlot operation.

WebAppsGetResponse

WebAppsGetResponse: Site & object

Contains response data for the get operation.

WebAppsGetSiteExtensionResponse

WebAppsGetSiteExtensionResponse: SiteExtensionInfo & object

Contains response data for the getSiteExtension operation.

WebAppsGetSiteExtensionSlotResponse

WebAppsGetSiteExtensionSlotResponse: SiteExtensionInfo & object

Contains response data for the getSiteExtensionSlot operation.

WebAppsGetSitePhpErrorLogFlagResponse

WebAppsGetSitePhpErrorLogFlagResponse: SitePhpErrorLogFlag & object

Contains response data for the getSitePhpErrorLogFlag operation.

WebAppsGetSitePhpErrorLogFlagSlotResponse

WebAppsGetSitePhpErrorLogFlagSlotResponse: SitePhpErrorLogFlag & object

Contains response data for the getSitePhpErrorLogFlagSlot operation.

WebAppsGetSlotResponse

WebAppsGetSlotResponse: Site & object

Contains response data for the getSlot operation.

WebAppsGetSourceControlResponse

WebAppsGetSourceControlResponse: SiteSourceControl & object

Contains response data for the getSourceControl operation.

WebAppsGetSourceControlSlotResponse

WebAppsGetSourceControlSlotResponse: SiteSourceControl & object

Contains response data for the getSourceControlSlot operation.

WebAppsGetSwiftVirtualNetworkConnectionResponse

WebAppsGetSwiftVirtualNetworkConnectionResponse: SwiftVirtualNetwork & object

Contains response data for the getSwiftVirtualNetworkConnection operation.

WebAppsGetSwiftVirtualNetworkConnectionSlotResponse

WebAppsGetSwiftVirtualNetworkConnectionSlotResponse: SwiftVirtualNetwork & object

Contains response data for the getSwiftVirtualNetworkConnectionSlot operation.

WebAppsGetTriggeredWebJobHistoryResponse

WebAppsGetTriggeredWebJobHistoryResponse: TriggeredJobHistory & object

Contains response data for the getTriggeredWebJobHistory operation.

WebAppsGetTriggeredWebJobHistorySlotResponse

WebAppsGetTriggeredWebJobHistorySlotResponse: TriggeredJobHistory & object

Contains response data for the getTriggeredWebJobHistorySlot operation.

WebAppsGetTriggeredWebJobResponse

WebAppsGetTriggeredWebJobResponse: TriggeredWebJob & object

Contains response data for the getTriggeredWebJob operation.

WebAppsGetTriggeredWebJobSlotResponse

WebAppsGetTriggeredWebJobSlotResponse: TriggeredWebJob & object

Contains response data for the getTriggeredWebJobSlot operation.

WebAppsGetVnetConnectionGatewayResponse

WebAppsGetVnetConnectionGatewayResponse: VnetGateway & object

Contains response data for the getVnetConnectionGateway operation.

WebAppsGetVnetConnectionGatewaySlotResponse

WebAppsGetVnetConnectionGatewaySlotResponse: VnetGateway & object

Contains response data for the getVnetConnectionGatewaySlot operation.

WebAppsGetVnetConnectionResponse

WebAppsGetVnetConnectionResponse: VnetInfo & object

Contains response data for the getVnetConnection operation.

WebAppsGetVnetConnectionSlotResponse

WebAppsGetVnetConnectionSlotResponse: VnetInfo & object

Contains response data for the getVnetConnectionSlot operation.

WebAppsGetWebJobResponse

WebAppsGetWebJobResponse: WebJob & object

Contains response data for the getWebJob operation.

WebAppsGetWebJobSlotResponse

WebAppsGetWebJobSlotResponse: WebJob & object

Contains response data for the getWebJobSlot operation.

WebAppsGetWebSiteContainerLogsResponse

WebAppsGetWebSiteContainerLogsResponse: object

Contains response data for the getWebSiteContainerLogs operation.

Type declaration

WebAppsGetWebSiteContainerLogsSlotResponse

WebAppsGetWebSiteContainerLogsSlotResponse: object

Contains response data for the getWebSiteContainerLogsSlot operation.

Type declaration

WebAppsInstallSiteExtensionResponse

WebAppsInstallSiteExtensionResponse: SiteExtensionInfo & object

Contains response data for the installSiteExtension operation.

WebAppsInstallSiteExtensionSlotResponse

WebAppsInstallSiteExtensionSlotResponse: SiteExtensionInfo & object

Contains response data for the installSiteExtensionSlot operation.

WebAppsIsCloneableResponse

WebAppsIsCloneableResponse: SiteCloneability & object

Contains response data for the isCloneable operation.

WebAppsIsCloneableSlotResponse

WebAppsIsCloneableSlotResponse: SiteCloneability & object

Contains response data for the isCloneableSlot operation.

WebAppsListApplicationSettingsResponse

WebAppsListApplicationSettingsResponse: StringDictionary & object

Contains response data for the listApplicationSettings operation.

WebAppsListApplicationSettingsSlotResponse

WebAppsListApplicationSettingsSlotResponse: StringDictionary & object

Contains response data for the listApplicationSettingsSlot operation.

WebAppsListAzureStorageAccountsResponse

WebAppsListAzureStorageAccountsResponse: AzureStoragePropertyDictionaryResource & object

Contains response data for the listAzureStorageAccounts operation.

WebAppsListAzureStorageAccountsSlotResponse

WebAppsListAzureStorageAccountsSlotResponse: AzureStoragePropertyDictionaryResource & object

Contains response data for the listAzureStorageAccountsSlot operation.

WebAppsListBackupStatusSecretsResponse

WebAppsListBackupStatusSecretsResponse: BackupItem & object

Contains response data for the listBackupStatusSecrets operation.

WebAppsListBackupStatusSecretsSlotResponse

WebAppsListBackupStatusSecretsSlotResponse: BackupItem & object

Contains response data for the listBackupStatusSecretsSlot operation.

WebAppsListBackupsNextResponse

WebAppsListBackupsNextResponse: BackupItemCollection & object

Contains response data for the listBackupsNext operation.

WebAppsListBackupsResponse

WebAppsListBackupsResponse: BackupItemCollection & object

Contains response data for the listBackups operation.

WebAppsListBackupsSlotNextResponse

WebAppsListBackupsSlotNextResponse: BackupItemCollection & object

Contains response data for the listBackupsSlotNext operation.

WebAppsListBackupsSlotResponse

WebAppsListBackupsSlotResponse: BackupItemCollection & object

Contains response data for the listBackupsSlot operation.

WebAppsListByResourceGroupNextResponse

WebAppsListByResourceGroupNextResponse: WebAppCollection & object

Contains response data for the listByResourceGroupNext operation.

WebAppsListByResourceGroupResponse

WebAppsListByResourceGroupResponse: WebAppCollection & object

Contains response data for the listByResourceGroup operation.

WebAppsListConfigurationSnapshotInfoNextResponse

WebAppsListConfigurationSnapshotInfoNextResponse: SiteConfigurationSnapshotInfoCollection & object

Contains response data for the listConfigurationSnapshotInfoNext operation.

WebAppsListConfigurationSnapshotInfoResponse

WebAppsListConfigurationSnapshotInfoResponse: SiteConfigurationSnapshotInfoCollection & object

Contains response data for the listConfigurationSnapshotInfo operation.

WebAppsListConfigurationSnapshotInfoSlotNextResponse

WebAppsListConfigurationSnapshotInfoSlotNextResponse: SiteConfigurationSnapshotInfoCollection & object

Contains response data for the listConfigurationSnapshotInfoSlotNext operation.

WebAppsListConfigurationSnapshotInfoSlotResponse

WebAppsListConfigurationSnapshotInfoSlotResponse: SiteConfigurationSnapshotInfoCollection & object

Contains response data for the listConfigurationSnapshotInfoSlot operation.

WebAppsListConfigurationsNextResponse

WebAppsListConfigurationsNextResponse: SiteConfigResourceCollection & object

Contains response data for the listConfigurationsNext operation.

WebAppsListConfigurationsResponse

WebAppsListConfigurationsResponse: SiteConfigResourceCollection & object

Contains response data for the listConfigurations operation.

WebAppsListConfigurationsSlotNextResponse

WebAppsListConfigurationsSlotNextResponse: SiteConfigResourceCollection & object

Contains response data for the listConfigurationsSlotNext operation.

WebAppsListConfigurationsSlotResponse

WebAppsListConfigurationsSlotResponse: SiteConfigResourceCollection & object

Contains response data for the listConfigurationsSlot operation.

WebAppsListConnectionStringsResponse

WebAppsListConnectionStringsResponse: ConnectionStringDictionary & object

Contains response data for the listConnectionStrings operation.

WebAppsListConnectionStringsSlotResponse

WebAppsListConnectionStringsSlotResponse: ConnectionStringDictionary & object

Contains response data for the listConnectionStringsSlot operation.

WebAppsListContinuousWebJobsNextResponse

WebAppsListContinuousWebJobsNextResponse: ContinuousWebJobCollection & object

Contains response data for the listContinuousWebJobsNext operation.

WebAppsListContinuousWebJobsResponse

WebAppsListContinuousWebJobsResponse: ContinuousWebJobCollection & object

Contains response data for the listContinuousWebJobs operation.

WebAppsListContinuousWebJobsSlotNextResponse

WebAppsListContinuousWebJobsSlotNextResponse: ContinuousWebJobCollection & object

Contains response data for the listContinuousWebJobsSlotNext operation.

WebAppsListContinuousWebJobsSlotResponse

WebAppsListContinuousWebJobsSlotResponse: ContinuousWebJobCollection & object

Contains response data for the listContinuousWebJobsSlot operation.

WebAppsListDeploymentLogResponse

WebAppsListDeploymentLogResponse: Deployment & object

Contains response data for the listDeploymentLog operation.

WebAppsListDeploymentLogSlotResponse

WebAppsListDeploymentLogSlotResponse: Deployment & object

Contains response data for the listDeploymentLogSlot operation.

WebAppsListDeploymentsNextResponse

WebAppsListDeploymentsNextResponse: DeploymentCollection & object

Contains response data for the listDeploymentsNext operation.

WebAppsListDeploymentsResponse

WebAppsListDeploymentsResponse: DeploymentCollection & object

Contains response data for the listDeployments operation.

WebAppsListDeploymentsSlotNextResponse

WebAppsListDeploymentsSlotNextResponse: DeploymentCollection & object

Contains response data for the listDeploymentsSlotNext operation.

WebAppsListDeploymentsSlotResponse

WebAppsListDeploymentsSlotResponse: DeploymentCollection & object

Contains response data for the listDeploymentsSlot operation.

WebAppsListDomainOwnershipIdentifiersNextResponse

WebAppsListDomainOwnershipIdentifiersNextResponse: IdentifierCollection & object

Contains response data for the listDomainOwnershipIdentifiersNext operation.

WebAppsListDomainOwnershipIdentifiersResponse

WebAppsListDomainOwnershipIdentifiersResponse: IdentifierCollection & object

Contains response data for the listDomainOwnershipIdentifiers operation.

WebAppsListDomainOwnershipIdentifiersSlotNextResponse

WebAppsListDomainOwnershipIdentifiersSlotNextResponse: IdentifierCollection & object

Contains response data for the listDomainOwnershipIdentifiersSlotNext operation.

WebAppsListDomainOwnershipIdentifiersSlotResponse

WebAppsListDomainOwnershipIdentifiersSlotResponse: IdentifierCollection & object

Contains response data for the listDomainOwnershipIdentifiersSlot operation.

WebAppsListFunctionSecretsResponse

WebAppsListFunctionSecretsResponse: FunctionSecrets & object

Contains response data for the listFunctionSecrets operation.

WebAppsListFunctionSecretsSlotResponse

WebAppsListFunctionSecretsSlotResponse: FunctionSecrets & object

Contains response data for the listFunctionSecretsSlot operation.

WebAppsListFunctionsNextResponse

WebAppsListFunctionsNextResponse: FunctionEnvelopeCollection & object

Contains response data for the listFunctionsNext operation.

WebAppsListFunctionsResponse

WebAppsListFunctionsResponse: FunctionEnvelopeCollection & object

Contains response data for the listFunctions operation.

WebAppsListHostNameBindingsNextResponse

WebAppsListHostNameBindingsNextResponse: HostNameBindingCollection & object

Contains response data for the listHostNameBindingsNext operation.

WebAppsListHostNameBindingsResponse

WebAppsListHostNameBindingsResponse: HostNameBindingCollection & object

Contains response data for the listHostNameBindings operation.

WebAppsListHostNameBindingsSlotNextResponse

WebAppsListHostNameBindingsSlotNextResponse: HostNameBindingCollection & object

Contains response data for the listHostNameBindingsSlotNext operation.

WebAppsListHostNameBindingsSlotResponse

WebAppsListHostNameBindingsSlotResponse: HostNameBindingCollection & object

Contains response data for the listHostNameBindingsSlot operation.

WebAppsListHybridConnectionKeysResponse

WebAppsListHybridConnectionKeysResponse: HybridConnectionKey & object

Contains response data for the listHybridConnectionKeys operation.

WebAppsListHybridConnectionKeysSlotResponse

WebAppsListHybridConnectionKeysSlotResponse: HybridConnectionKey & object

Contains response data for the listHybridConnectionKeysSlot operation.

WebAppsListHybridConnectionsResponse

WebAppsListHybridConnectionsResponse: HybridConnection & object

Contains response data for the listHybridConnections operation.

WebAppsListHybridConnectionsSlotResponse

WebAppsListHybridConnectionsSlotResponse: HybridConnection & object

Contains response data for the listHybridConnectionsSlot operation.

WebAppsListInstanceFunctionsSlotNextResponse

WebAppsListInstanceFunctionsSlotNextResponse: FunctionEnvelopeCollection & object

Contains response data for the listInstanceFunctionsSlotNext operation.

WebAppsListInstanceFunctionsSlotResponse

WebAppsListInstanceFunctionsSlotResponse: FunctionEnvelopeCollection & object

Contains response data for the listInstanceFunctionsSlot operation.

WebAppsListInstanceIdentifiersNextResponse

WebAppsListInstanceIdentifiersNextResponse: WebAppInstanceCollection & object

Contains response data for the listInstanceIdentifiersNext operation.

WebAppsListInstanceIdentifiersResponse

WebAppsListInstanceIdentifiersResponse: WebAppInstanceCollection & object

Contains response data for the listInstanceIdentifiers operation.

WebAppsListInstanceIdentifiersSlotNextResponse

WebAppsListInstanceIdentifiersSlotNextResponse: WebAppInstanceCollection & object

Contains response data for the listInstanceIdentifiersSlotNext operation.

WebAppsListInstanceIdentifiersSlotResponse

WebAppsListInstanceIdentifiersSlotResponse: WebAppInstanceCollection & object

Contains response data for the listInstanceIdentifiersSlot operation.

WebAppsListInstanceProcessModulesNextResponse

WebAppsListInstanceProcessModulesNextResponse: ProcessModuleInfoCollection & object

Contains response data for the listInstanceProcessModulesNext operation.

WebAppsListInstanceProcessModulesResponse

WebAppsListInstanceProcessModulesResponse: ProcessModuleInfoCollection & object

Contains response data for the listInstanceProcessModules operation.

WebAppsListInstanceProcessModulesSlotNextResponse

WebAppsListInstanceProcessModulesSlotNextResponse: ProcessModuleInfoCollection & object

Contains response data for the listInstanceProcessModulesSlotNext operation.

WebAppsListInstanceProcessModulesSlotResponse

WebAppsListInstanceProcessModulesSlotResponse: ProcessModuleInfoCollection & object

Contains response data for the listInstanceProcessModulesSlot operation.

WebAppsListInstanceProcessThreadsNextResponse

WebAppsListInstanceProcessThreadsNextResponse: ProcessThreadInfoCollection & object

Contains response data for the listInstanceProcessThreadsNext operation.

WebAppsListInstanceProcessThreadsResponse

WebAppsListInstanceProcessThreadsResponse: ProcessThreadInfoCollection & object

Contains response data for the listInstanceProcessThreads operation.

WebAppsListInstanceProcessThreadsSlotNextResponse

WebAppsListInstanceProcessThreadsSlotNextResponse: ProcessThreadInfoCollection & object

Contains response data for the listInstanceProcessThreadsSlotNext operation.

WebAppsListInstanceProcessThreadsSlotResponse

WebAppsListInstanceProcessThreadsSlotResponse: ProcessThreadInfoCollection & object

Contains response data for the listInstanceProcessThreadsSlot operation.

WebAppsListInstanceProcessesNextResponse

WebAppsListInstanceProcessesNextResponse: ProcessInfoCollection & object

Contains response data for the listInstanceProcessesNext operation.

WebAppsListInstanceProcessesResponse

WebAppsListInstanceProcessesResponse: ProcessInfoCollection & object

Contains response data for the listInstanceProcesses operation.

WebAppsListInstanceProcessesSlotNextResponse

WebAppsListInstanceProcessesSlotNextResponse: ProcessInfoCollection & object

Contains response data for the listInstanceProcessesSlotNext operation.

WebAppsListInstanceProcessesSlotResponse

WebAppsListInstanceProcessesSlotResponse: ProcessInfoCollection & object

Contains response data for the listInstanceProcessesSlot operation.

WebAppsListMetadataResponse

WebAppsListMetadataResponse: StringDictionary & object

Contains response data for the listMetadata operation.

WebAppsListMetadataSlotResponse

WebAppsListMetadataSlotResponse: StringDictionary & object

Contains response data for the listMetadataSlot operation.

WebAppsListMetricDefinitionsNextResponse

WebAppsListMetricDefinitionsNextResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefinitionsNext operation.

WebAppsListMetricDefinitionsResponse

WebAppsListMetricDefinitionsResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefinitions operation.

WebAppsListMetricDefinitionsSlotNextResponse

WebAppsListMetricDefinitionsSlotNextResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefinitionsSlotNext operation.

WebAppsListMetricDefinitionsSlotResponse

WebAppsListMetricDefinitionsSlotResponse: ResourceMetricDefinitionCollection & object

Contains response data for the listMetricDefinitionsSlot operation.

WebAppsListMetricsNextResponse

WebAppsListMetricsNextResponse: ResourceMetricCollection & object

Contains response data for the listMetricsNext operation.

WebAppsListMetricsResponse

WebAppsListMetricsResponse: ResourceMetricCollection & object

Contains response data for the listMetrics operation.

WebAppsListMetricsSlotNextResponse

WebAppsListMetricsSlotNextResponse: ResourceMetricCollection & object

Contains response data for the listMetricsSlotNext operation.

WebAppsListMetricsSlotResponse

WebAppsListMetricsSlotResponse: ResourceMetricCollection & object

Contains response data for the listMetricsSlot operation.

WebAppsListNetworkFeaturesResponse

WebAppsListNetworkFeaturesResponse: NetworkFeatures & object

Contains response data for the listNetworkFeatures operation.

WebAppsListNetworkFeaturesSlotResponse

WebAppsListNetworkFeaturesSlotResponse: NetworkFeatures & object

Contains response data for the listNetworkFeaturesSlot operation.

WebAppsListNextResponse

WebAppsListNextResponse: WebAppCollection & object

Contains response data for the listNext operation.

WebAppsListPerfMonCountersNextResponse

WebAppsListPerfMonCountersNextResponse: PerfMonCounterCollection & object

Contains response data for the listPerfMonCountersNext operation.

WebAppsListPerfMonCountersResponse

WebAppsListPerfMonCountersResponse: PerfMonCounterCollection & object

Contains response data for the listPerfMonCounters operation.

WebAppsListPerfMonCountersSlotNextResponse

WebAppsListPerfMonCountersSlotNextResponse: PerfMonCounterCollection & object

Contains response data for the listPerfMonCountersSlotNext operation.

WebAppsListPerfMonCountersSlotResponse

WebAppsListPerfMonCountersSlotResponse: PerfMonCounterCollection & object

Contains response data for the listPerfMonCountersSlot operation.

WebAppsListPremierAddOnsResponse

WebAppsListPremierAddOnsResponse: PremierAddOn & object

Contains response data for the listPremierAddOns operation.

WebAppsListPremierAddOnsSlotResponse

WebAppsListPremierAddOnsSlotResponse: PremierAddOn & object

Contains response data for the listPremierAddOnsSlot operation.

WebAppsListProcessModulesNextResponse

WebAppsListProcessModulesNextResponse: ProcessModuleInfoCollection & object

Contains response data for the listProcessModulesNext operation.

WebAppsListProcessModulesResponse

WebAppsListProcessModulesResponse: ProcessModuleInfoCollection & object

Contains response data for the listProcessModules operation.

WebAppsListProcessModulesSlotNextResponse

WebAppsListProcessModulesSlotNextResponse: ProcessModuleInfoCollection & object

Contains response data for the listProcessModulesSlotNext operation.

WebAppsListProcessModulesSlotResponse

WebAppsListProcessModulesSlotResponse: ProcessModuleInfoCollection & object

Contains response data for the listProcessModulesSlot operation.

WebAppsListProcessThreadsNextResponse

WebAppsListProcessThreadsNextResponse: ProcessThreadInfoCollection & object

Contains response data for the listProcessThreadsNext operation.

WebAppsListProcessThreadsResponse

WebAppsListProcessThreadsResponse: ProcessThreadInfoCollection & object

Contains response data for the listProcessThreads operation.

WebAppsListProcessThreadsSlotNextResponse

WebAppsListProcessThreadsSlotNextResponse: ProcessThreadInfoCollection & object

Contains response data for the listProcessThreadsSlotNext operation.

WebAppsListProcessThreadsSlotResponse

WebAppsListProcessThreadsSlotResponse: ProcessThreadInfoCollection & object

Contains response data for the listProcessThreadsSlot operation.

WebAppsListProcessesNextResponse

WebAppsListProcessesNextResponse: ProcessInfoCollection & object

Contains response data for the listProcessesNext operation.

WebAppsListProcessesResponse

WebAppsListProcessesResponse: ProcessInfoCollection & object

Contains response data for the listProcesses operation.

WebAppsListProcessesSlotNextResponse

WebAppsListProcessesSlotNextResponse: ProcessInfoCollection & object

Contains response data for the listProcessesSlotNext operation.

WebAppsListProcessesSlotResponse

WebAppsListProcessesSlotResponse: ProcessInfoCollection & object

Contains response data for the listProcessesSlot operation.

WebAppsListPublicCertificatesNextResponse

WebAppsListPublicCertificatesNextResponse: PublicCertificateCollection & object

Contains response data for the listPublicCertificatesNext operation.

WebAppsListPublicCertificatesResponse

WebAppsListPublicCertificatesResponse: PublicCertificateCollection & object

Contains response data for the listPublicCertificates operation.

WebAppsListPublicCertificatesSlotNextResponse

WebAppsListPublicCertificatesSlotNextResponse: PublicCertificateCollection & object

Contains response data for the listPublicCertificatesSlotNext operation.

WebAppsListPublicCertificatesSlotResponse

WebAppsListPublicCertificatesSlotResponse: PublicCertificateCollection & object

Contains response data for the listPublicCertificatesSlot operation.

WebAppsListPublishingCredentialsResponse

WebAppsListPublishingCredentialsResponse: User & object

Contains response data for the listPublishingCredentials operation.

WebAppsListPublishingCredentialsSlotResponse

WebAppsListPublishingCredentialsSlotResponse: User & object

Contains response data for the listPublishingCredentialsSlot operation.

WebAppsListPublishingProfileXmlWithSecretsResponse

WebAppsListPublishingProfileXmlWithSecretsResponse: object

Contains response data for the listPublishingProfileXmlWithSecrets operation.

Type declaration

WebAppsListPublishingProfileXmlWithSecretsSlotResponse

WebAppsListPublishingProfileXmlWithSecretsSlotResponse: object

Contains response data for the listPublishingProfileXmlWithSecretsSlot operation.

Type declaration

WebAppsListRelayServiceConnectionsResponse

WebAppsListRelayServiceConnectionsResponse: RelayServiceConnectionEntity & object

Contains response data for the listRelayServiceConnections operation.

WebAppsListRelayServiceConnectionsSlotResponse

WebAppsListRelayServiceConnectionsSlotResponse: RelayServiceConnectionEntity & object

Contains response data for the listRelayServiceConnectionsSlot operation.

WebAppsListResponse

WebAppsListResponse: WebAppCollection & object

Contains response data for the list operation.

WebAppsListSiteExtensionsNextResponse

WebAppsListSiteExtensionsNextResponse: SiteExtensionInfoCollection & object

Contains response data for the listSiteExtensionsNext operation.

WebAppsListSiteExtensionsResponse

WebAppsListSiteExtensionsResponse: SiteExtensionInfoCollection & object

Contains response data for the listSiteExtensions operation.

WebAppsListSiteExtensionsSlotNextResponse

WebAppsListSiteExtensionsSlotNextResponse: SiteExtensionInfoCollection & object

Contains response data for the listSiteExtensionsSlotNext operation.

WebAppsListSiteExtensionsSlotResponse

WebAppsListSiteExtensionsSlotResponse: SiteExtensionInfoCollection & object

Contains response data for the listSiteExtensionsSlot operation.

WebAppsListSitePushSettingsResponse

WebAppsListSitePushSettingsResponse: PushSettings & object

Contains response data for the listSitePushSettings operation.

WebAppsListSitePushSettingsSlotResponse

WebAppsListSitePushSettingsSlotResponse: PushSettings & object

Contains response data for the listSitePushSettingsSlot operation.

WebAppsListSlotConfigurationNamesResponse

WebAppsListSlotConfigurationNamesResponse: SlotConfigNamesResource & object

Contains response data for the listSlotConfigurationNames operation.

WebAppsListSlotDifferencesFromProductionNextResponse

WebAppsListSlotDifferencesFromProductionNextResponse: SlotDifferenceCollection & object

Contains response data for the listSlotDifferencesFromProductionNext operation.

WebAppsListSlotDifferencesFromProductionResponse

WebAppsListSlotDifferencesFromProductionResponse: SlotDifferenceCollection & object

Contains response data for the listSlotDifferencesFromProduction operation.

WebAppsListSlotDifferencesSlotNextResponse

WebAppsListSlotDifferencesSlotNextResponse: SlotDifferenceCollection & object

Contains response data for the listSlotDifferencesSlotNext operation.

WebAppsListSlotDifferencesSlotResponse

WebAppsListSlotDifferencesSlotResponse: SlotDifferenceCollection & object

Contains response data for the listSlotDifferencesSlot operation.

WebAppsListSlotsNextResponse

WebAppsListSlotsNextResponse: WebAppCollection & object

Contains response data for the listSlotsNext operation.

WebAppsListSlotsResponse

WebAppsListSlotsResponse: WebAppCollection & object

Contains response data for the listSlots operation.

WebAppsListSnapshotsFromDRSecondaryNextResponse

WebAppsListSnapshotsFromDRSecondaryNextResponse: SnapshotCollection & object

Contains response data for the listSnapshotsFromDRSecondaryNext operation.

WebAppsListSnapshotsFromDRSecondaryResponse

WebAppsListSnapshotsFromDRSecondaryResponse: SnapshotCollection & object

Contains response data for the listSnapshotsFromDRSecondary operation.

WebAppsListSnapshotsFromDRSecondarySlotNextResponse

WebAppsListSnapshotsFromDRSecondarySlotNextResponse: SnapshotCollection & object

Contains response data for the listSnapshotsFromDRSecondarySlotNext operation.

WebAppsListSnapshotsFromDRSecondarySlotResponse

WebAppsListSnapshotsFromDRSecondarySlotResponse: SnapshotCollection & object

Contains response data for the listSnapshotsFromDRSecondarySlot operation.

WebAppsListSnapshotsNextResponse

WebAppsListSnapshotsNextResponse: SnapshotCollection & object

Contains response data for the listSnapshotsNext operation.

WebAppsListSnapshotsResponse

WebAppsListSnapshotsResponse: SnapshotCollection & object

Contains response data for the listSnapshots operation.

WebAppsListSnapshotsSlotNextResponse

WebAppsListSnapshotsSlotNextResponse: SnapshotCollection & object

Contains response data for the listSnapshotsSlotNext operation.

WebAppsListSnapshotsSlotResponse

WebAppsListSnapshotsSlotResponse: SnapshotCollection & object

Contains response data for the listSnapshotsSlot operation.

WebAppsListSyncFunctionTriggersResponse

WebAppsListSyncFunctionTriggersResponse: FunctionSecrets & object

Contains response data for the listSyncFunctionTriggers operation.

WebAppsListSyncFunctionTriggersSlotResponse

WebAppsListSyncFunctionTriggersSlotResponse: FunctionSecrets & object

Contains response data for the listSyncFunctionTriggersSlot operation.

WebAppsListTriggeredWebJobHistoryNextResponse

WebAppsListTriggeredWebJobHistoryNextResponse: TriggeredJobHistoryCollection & object

Contains response data for the listTriggeredWebJobHistoryNext operation.

WebAppsListTriggeredWebJobHistoryResponse

WebAppsListTriggeredWebJobHistoryResponse: TriggeredJobHistoryCollection & object

Contains response data for the listTriggeredWebJobHistory operation.

WebAppsListTriggeredWebJobHistorySlotNextResponse

WebAppsListTriggeredWebJobHistorySlotNextResponse: TriggeredJobHistoryCollection & object

Contains response data for the listTriggeredWebJobHistorySlotNext operation.

WebAppsListTriggeredWebJobHistorySlotResponse

WebAppsListTriggeredWebJobHistorySlotResponse: TriggeredJobHistoryCollection & object

Contains response data for the listTriggeredWebJobHistorySlot operation.

WebAppsListTriggeredWebJobsNextResponse

WebAppsListTriggeredWebJobsNextResponse: TriggeredWebJobCollection & object

Contains response data for the listTriggeredWebJobsNext operation.

WebAppsListTriggeredWebJobsResponse

WebAppsListTriggeredWebJobsResponse: TriggeredWebJobCollection & object

Contains response data for the listTriggeredWebJobs operation.

WebAppsListTriggeredWebJobsSlotNextResponse

WebAppsListTriggeredWebJobsSlotNextResponse: TriggeredWebJobCollection & object

Contains response data for the listTriggeredWebJobsSlotNext operation.

WebAppsListTriggeredWebJobsSlotResponse

WebAppsListTriggeredWebJobsSlotResponse: TriggeredWebJobCollection & object

Contains response data for the listTriggeredWebJobsSlot operation.

WebAppsListUsagesNextResponse

WebAppsListUsagesNextResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsagesNext operation.

WebAppsListUsagesResponse

WebAppsListUsagesResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsages operation.

WebAppsListUsagesSlotNextResponse

WebAppsListUsagesSlotNextResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsagesSlotNext operation.

WebAppsListUsagesSlotResponse

WebAppsListUsagesSlotResponse: CsmUsageQuotaCollection & object

Contains response data for the listUsagesSlot operation.

WebAppsListVnetConnectionsResponse

WebAppsListVnetConnectionsResponse: Array<VnetInfo> & object

Contains response data for the listVnetConnections operation.

WebAppsListVnetConnectionsSlotResponse

WebAppsListVnetConnectionsSlotResponse: Array<VnetInfo> & object

Contains response data for the listVnetConnectionsSlot operation.

WebAppsListWebJobsNextResponse

WebAppsListWebJobsNextResponse: WebJobCollection & object

Contains response data for the listWebJobsNext operation.

WebAppsListWebJobsResponse

WebAppsListWebJobsResponse: WebJobCollection & object

Contains response data for the listWebJobs operation.

WebAppsListWebJobsSlotNextResponse

WebAppsListWebJobsSlotNextResponse: WebJobCollection & object

Contains response data for the listWebJobsSlotNext operation.

WebAppsListWebJobsSlotResponse

WebAppsListWebJobsSlotResponse: WebJobCollection & object

Contains response data for the listWebJobsSlot operation.

WebAppsMigrateMySqlResponse

WebAppsMigrateMySqlResponse: Operation & object

Contains response data for the migrateMySql operation.

WebAppsMigrateStorageResponse

WebAppsMigrateStorageResponse: StorageMigrationResponse & object

Contains response data for the migrateStorage operation.

WebAppsPutPrivateAccessVnetResponse

WebAppsPutPrivateAccessVnetResponse: PrivateAccess & object

Contains response data for the putPrivateAccessVnet operation.

WebAppsPutPrivateAccessVnetSlotResponse

WebAppsPutPrivateAccessVnetSlotResponse: PrivateAccess & object

Contains response data for the putPrivateAccessVnetSlot operation.

WebAppsStartNetworkTraceResponse

WebAppsStartNetworkTraceResponse: Array<NetworkTrace> & object

Contains response data for the startNetworkTrace operation.

WebAppsStartNetworkTraceSlotResponse

WebAppsStartNetworkTraceSlotResponse: Array<NetworkTrace> & object

Contains response data for the startNetworkTraceSlot operation.

WebAppsStartWebSiteNetworkTraceOperationResponse

WebAppsStartWebSiteNetworkTraceOperationResponse: Array<NetworkTrace> & object

Contains response data for the startWebSiteNetworkTraceOperation operation.

WebAppsStartWebSiteNetworkTraceOperationSlotResponse

WebAppsStartWebSiteNetworkTraceOperationSlotResponse: Array<NetworkTrace> & object

Contains response data for the startWebSiteNetworkTraceOperationSlot operation.

WebAppsStartWebSiteNetworkTraceResponse

WebAppsStartWebSiteNetworkTraceResponse: object

Contains response data for the startWebSiteNetworkTrace operation.

Type declaration

WebAppsStartWebSiteNetworkTraceSlotResponse

WebAppsStartWebSiteNetworkTraceSlotResponse: object

Contains response data for the startWebSiteNetworkTraceSlot operation.

Type declaration

WebAppsUpdateApplicationSettingsResponse

WebAppsUpdateApplicationSettingsResponse: StringDictionary & object

Contains response data for the updateApplicationSettings operation.

WebAppsUpdateApplicationSettingsSlotResponse

WebAppsUpdateApplicationSettingsSlotResponse: StringDictionary & object

Contains response data for the updateApplicationSettingsSlot operation.

WebAppsUpdateAuthSettingsResponse

WebAppsUpdateAuthSettingsResponse: SiteAuthSettings & object

Contains response data for the updateAuthSettings operation.

WebAppsUpdateAuthSettingsSlotResponse

WebAppsUpdateAuthSettingsSlotResponse: SiteAuthSettings & object

Contains response data for the updateAuthSettingsSlot operation.

WebAppsUpdateAzureStorageAccountsResponse

WebAppsUpdateAzureStorageAccountsResponse: AzureStoragePropertyDictionaryResource & object

Contains response data for the updateAzureStorageAccounts operation.

WebAppsUpdateAzureStorageAccountsSlotResponse

WebAppsUpdateAzureStorageAccountsSlotResponse: AzureStoragePropertyDictionaryResource & object

Contains response data for the updateAzureStorageAccountsSlot operation.

WebAppsUpdateBackupConfigurationResponse

WebAppsUpdateBackupConfigurationResponse: BackupRequest & object

Contains response data for the updateBackupConfiguration operation.

WebAppsUpdateBackupConfigurationSlotResponse

WebAppsUpdateBackupConfigurationSlotResponse: BackupRequest & object

Contains response data for the updateBackupConfigurationSlot operation.

WebAppsUpdateConfigurationResponse

WebAppsUpdateConfigurationResponse: SiteConfigResource & object

Contains response data for the updateConfiguration operation.

WebAppsUpdateConfigurationSlotResponse

WebAppsUpdateConfigurationSlotResponse: SiteConfigResource & object

Contains response data for the updateConfigurationSlot operation.

WebAppsUpdateConnectionStringsResponse

WebAppsUpdateConnectionStringsResponse: ConnectionStringDictionary & object

Contains response data for the updateConnectionStrings operation.

WebAppsUpdateConnectionStringsSlotResponse

WebAppsUpdateConnectionStringsSlotResponse: ConnectionStringDictionary & object

Contains response data for the updateConnectionStringsSlot operation.

WebAppsUpdateDiagnosticLogsConfigResponse

WebAppsUpdateDiagnosticLogsConfigResponse: SiteLogsConfig & object

Contains response data for the updateDiagnosticLogsConfig operation.

WebAppsUpdateDiagnosticLogsConfigSlotResponse

WebAppsUpdateDiagnosticLogsConfigSlotResponse: SiteLogsConfig & object

Contains response data for the updateDiagnosticLogsConfigSlot operation.

WebAppsUpdateDomainOwnershipIdentifierResponse

WebAppsUpdateDomainOwnershipIdentifierResponse: Identifier & object

Contains response data for the updateDomainOwnershipIdentifier operation.

WebAppsUpdateDomainOwnershipIdentifierSlotResponse

WebAppsUpdateDomainOwnershipIdentifierSlotResponse: Identifier & object

Contains response data for the updateDomainOwnershipIdentifierSlot operation.

WebAppsUpdateHybridConnectionResponse

WebAppsUpdateHybridConnectionResponse: HybridConnection & object

Contains response data for the updateHybridConnection operation.

WebAppsUpdateHybridConnectionSlotResponse

WebAppsUpdateHybridConnectionSlotResponse: HybridConnection & object

Contains response data for the updateHybridConnectionSlot operation.

WebAppsUpdateMetadataResponse

WebAppsUpdateMetadataResponse: StringDictionary & object

Contains response data for the updateMetadata operation.

WebAppsUpdateMetadataSlotResponse

WebAppsUpdateMetadataSlotResponse: StringDictionary & object

Contains response data for the updateMetadataSlot operation.

WebAppsUpdatePremierAddOnResponse

WebAppsUpdatePremierAddOnResponse: PremierAddOn & object

Contains response data for the updatePremierAddOn operation.

WebAppsUpdatePremierAddOnSlotResponse

WebAppsUpdatePremierAddOnSlotResponse: PremierAddOn & object

Contains response data for the updatePremierAddOnSlot operation.

WebAppsUpdateRelayServiceConnectionResponse

WebAppsUpdateRelayServiceConnectionResponse: RelayServiceConnectionEntity & object

Contains response data for the updateRelayServiceConnection operation.

WebAppsUpdateRelayServiceConnectionSlotResponse

WebAppsUpdateRelayServiceConnectionSlotResponse: RelayServiceConnectionEntity & object

Contains response data for the updateRelayServiceConnectionSlot operation.

WebAppsUpdateResponse

WebAppsUpdateResponse: Site & object

Contains response data for the update operation.

WebAppsUpdateSitePushSettingsResponse

WebAppsUpdateSitePushSettingsResponse: PushSettings & object

Contains response data for the updateSitePushSettings operation.

WebAppsUpdateSitePushSettingsSlotResponse

WebAppsUpdateSitePushSettingsSlotResponse: PushSettings & object

Contains response data for the updateSitePushSettingsSlot operation.

WebAppsUpdateSlotConfigurationNamesResponse

WebAppsUpdateSlotConfigurationNamesResponse: SlotConfigNamesResource & object

Contains response data for the updateSlotConfigurationNames operation.

WebAppsUpdateSlotResponse

WebAppsUpdateSlotResponse: Site & object

Contains response data for the updateSlot operation.

WebAppsUpdateSourceControlResponse

WebAppsUpdateSourceControlResponse: SiteSourceControl & object

Contains response data for the updateSourceControl operation.

WebAppsUpdateSourceControlSlotResponse

WebAppsUpdateSourceControlSlotResponse: SiteSourceControl & object

Contains response data for the updateSourceControlSlot operation.

WebAppsUpdateSwiftVirtualNetworkConnectionResponse

WebAppsUpdateSwiftVirtualNetworkConnectionResponse: SwiftVirtualNetwork & object

Contains response data for the updateSwiftVirtualNetworkConnection operation.

WebAppsUpdateSwiftVirtualNetworkConnectionSlotResponse

WebAppsUpdateSwiftVirtualNetworkConnectionSlotResponse: SwiftVirtualNetwork & object

Contains response data for the updateSwiftVirtualNetworkConnectionSlot operation.

WebAppsUpdateVnetConnectionGatewayResponse

WebAppsUpdateVnetConnectionGatewayResponse: VnetGateway & object

Contains response data for the updateVnetConnectionGateway operation.

WebAppsUpdateVnetConnectionGatewaySlotResponse

WebAppsUpdateVnetConnectionGatewaySlotResponse: VnetGateway & object

Contains response data for the updateVnetConnectionGatewaySlot operation.

WebAppsUpdateVnetConnectionResponse

WebAppsUpdateVnetConnectionResponse: VnetInfo & object

Contains response data for the updateVnetConnection operation.

WebAppsUpdateVnetConnectionSlotResponse

WebAppsUpdateVnetConnectionSlotResponse: VnetInfo & object

Contains response data for the updateVnetConnectionSlot operation.

WebJobType

WebJobType: "Continuous" | "Triggered"

Defines values for WebJobType. Possible values include: 'Continuous', 'Triggered'

readonly
enum: {string}

WorkerSizeOptions

WorkerSizeOptions: "Small" | "Medium" | "Large" | "D1" | "D2" | "D3" | "Default"

Defines values for WorkerSizeOptions. Possible values include: 'Small', 'Medium', 'Large', 'D1', 'D2', 'D3', 'Default'

readonly
enum: {string}

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AbnormalTimePeriod

AbnormalTimePeriod: object

interface: An interface representing AbnormalTimePeriod. Class representing Abnormal Time Period identified in diagnosis

Optional endTime

endTime: Date

member: {Date} [endTime] End time of the downtime

Optional events

events: DetectorAbnormalTimePeriod[]

member: {DetectorAbnormalTimePeriod[]} [events] List of Possible Cause of downtime

serializedName

serializedName: string = "AbnormalTimePeriod"

Optional solutions

solutions: Solution[]

member: {Solution[]} [solutions] List of proposed solutions

Optional startTime

startTime: Date

member: {Date} [startTime] Start time of the downtime

type

type: object

className

className: string = "AbnormalTimePeriod"

name

modelProperties

name

Const Address

Address: object

interface: An interface representing Address. Address information for domain registration.

address1

address1: string

member: {string} address1 First line of an Address.

Optional address2

address2: undefined | string

member: {string} [address2] The second line of the Address. Optional.

city

city: string

member: {string} city The city for the address.

country

country: string

member: {string} country The country for the address.

postalCode

postalCode: string

member: {string} postalCode The postal code for the address.

serializedName

serializedName: string = "Address"

state

state: string

member: {string} state The state or province for the address.

type

type: object

className

className: string = "Address"

name

modelProperties

modelProperties: object

address1

address1: object

required

required: true = true

serializedName

serializedName: string = "address1"

type

type: object

AddressResponse: object

interface: An interface representing AddressResponse. Describes main public IP address and any extra virtual IPs.

Optional internalIpAddress

internalIpAddress: undefined | string

member: {string} [internalIpAddress] Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode.

Optional outboundIpAddresses

outboundIpAddresses: string[]

member: {string[]} [outboundIpAddresses] IP addresses appearing on outbound connections.

serializedName

serializedName: string = "AddressResponse"

Optional serviceIpAddress

serviceIpAddress: undefined | string

member: {string} [serviceIpAddress] Main public virtual IP.

Optional vipMappings

vipMappings: VirtualIPMapping[]

member: {VirtualIPMapping[]} [vipMappings] Additional virtual IPs.

type

type: object

className

className: string = "AddressResponse"

name

modelProperties

modelProperties: object

internalIpAddress

internalIpAddress: object

serializedName

serializedName: string = "internalIpAddress"

type

type: object

name

outboundIpAddresses

outboundIpAddresses: object

serializedName

serializedName: string = "outboundIpAddresses"

type

type: object

AnalysisData: object

interface: An interface representing AnalysisData. Class Representing Detector Evidence used for analysis

Optional data

data: NameValuePair[][]

member: {NameValuePair[][]} [data] Additional Source Data

Optional detectorDefinition

detectorDefinition: DetectorDefinition

member: {DetectorDefinition} [detectorDefinition] Detector Definition

Optional detectorMetaData

detectorMetaData: ResponseMetaData

member: {ResponseMetaData} [detectorMetaData] Detector Meta Data

Optional metrics

metrics: DiagnosticMetricSet[]

member: {DiagnosticMetricSet[]} [metrics] Source Metrics

serializedName

serializedName: string = "AnalysisData"

Optional source

source: undefined | string

member: {string} [source] Name of the Detector

type

type: object

className

className: string = "AnalysisData"

name

modelProperties

modelProperties: object

data

className

className: string = "NameValuePair"

name

detectorDefinition

detectorDefinition: object

serializedName

serializedName: string = "detectorDefinition"

type

type: object

className

className: string = "DetectorDefinition"

name

detectorMetaData

name

Const AnalysisDefinition

AnalysisDefinition: object

interface: An interface representing AnalysisDefinition. Definition of Analysis
extends: ProxyOnlyResource

Optional description

description: undefined | string

member: {string} [description] Description of the Analysis NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AnalysisDefinition"

type

type: object

className

className: string = "AnalysisDefinition"

name

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

Const ApiDefinitionInfo

ApiDefinitionInfo: object

interface: An interface representing ApiDefinitionInfo. Information about the formal API definition for the app.

serializedName

serializedName: string = "ApiDefinitionInfo"

Optional url

url: undefined | string

member: {string} [url] The URL of the API definition.

type

type: object

className

className: string = "ApiDefinitionInfo"

name

modelProperties

modelProperties: object

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

Const AppServiceCertificate

AppServiceCertificate: object

interface: An interface representing AppServiceCertificate. Key Vault container for a certificate that is purchased through Azure.

Optional keyVaultId

keyVaultId: undefined | string

member: {string} [keyVaultId] Key Vault resource Id.

Optional keyVaultSecretName

keyVaultSecretName: undefined | string

member: {string} [keyVaultSecretName] Key Vault secret name.

Optional provisioningState

provisioningState: KeyVaultSecretStatus

member: {KeyVaultSecretStatus} [provisioningState] Status of the Key Vault secret. Possible values include: 'Initialized', 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceCertificate"

type

type: object

className

className: string = "AppServiceCertificate"

name

modelProperties

type

type: object

allowedValues

allowedValues: string[] = ["Initialized","WaitingOnCertificateOrder","Succeeded","CertificateOrderFailed","OperationNotPermittedOnKeyVault","AzureServiceUnauthorizedToAccessKeyVault","KeyVaultDoesNotExist","KeyVaultSecretDoesNotExist","UnknownError","ExternalPrivateKey","Unknown"]

name

Const AppServiceCertificateCollection

AppServiceCertificateCollection: object

interface: An interface representing the AppServiceCertificateCollection. Collection of certitificateorder certificates.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceCertificateCollection"

__@iterator

__@iterator(): IterableIterator<AppServiceCertificateResource>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<AppServiceCertificateResource>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<AppServiceCertificateResource>[]): AppServiceCertificateResource[]
concat(...items: (T | ConcatArray<T>)[]): AppServiceCertificateResource[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<AppServiceCertificateResource>[]
 
 Additional items to add to the end of array1.
Returns AppServiceCertificateResource[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns AppServiceCertificateResource[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, AppServiceCertificateResource]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, AppServiceCertificateResource]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: AppServiceCertificateResource, index: number, array: AppServiceCertificateResource[]): boolean
    - Parameters
      - value: AppServiceCertificateResource
      - index: number
      - array: AppServiceCertificateResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: AppServiceCertificateResource, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: AppServiceCertificateResource
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): AppServiceCertificateResource[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: AppServiceCertificateResource
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceCertificateResource, index: number, array: AppServiceCertificateResource[]): boolean
    - Parameters
      - value: AppServiceCertificateResource
      - index: number
      - array: AppServiceCertificateResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceCertificateResource, index: number, array: AppServiceCertificateResource[]): any
    - Parameters
      - value: AppServiceCertificateResource
      - index: number
      - array: AppServiceCertificateResource[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns AppServiceCertificateResource[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): AppServiceCertificateResource | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: AppServiceCertificateResource
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: AppServiceCertificateResource, index: number, obj: AppServiceCertificateResource[]): boolean
    - Parameters
      - this: void
      - value: AppServiceCertificateResource
      - index: number
      - obj: AppServiceCertificateResource[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: AppServiceCertificateResource, index: number, obj: AppServiceCertificateResource[]): boolean
    - Parameters
      - value: AppServiceCertificateResource
      - index: number
      - obj: AppServiceCertificateResource[]
      Returns boolean
- Optional thisArg: any
Returns AppServiceCertificateResource | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: AppServiceCertificateResource, index: number, obj: AppServiceCertificateResource[]): boolean
    - Parameters
      - value: AppServiceCertificateResource
      - index: number
      - obj: AppServiceCertificateResource[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceCertificateResource, index: number, array: AppServiceCertificateResource[]): void
    - Parameters
      - value: AppServiceCertificateResource
      - index: number
      - array: AppServiceCertificateResource[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: AppServiceCertificateResource, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: AppServiceCertificateResource
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: AppServiceCertificateResource, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: AppServiceCertificateResource
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: AppServiceCertificateResource, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: AppServiceCertificateResource
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceCertificateResource, index: number, array: AppServiceCertificateResource[]): U
    - Parameters
      - value: AppServiceCertificateResource
      - index: number
      - array: AppServiceCertificateResource[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): AppServiceCertificateResource | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns AppServiceCertificateResource | undefined

push

push(...items: AppServiceCertificateResource[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: AppServiceCertificateResource[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): AppServiceCertificateResource
reduce(callbackfn: function, initialValue: AppServiceCertificateResource): AppServiceCertificateResource
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: AppServiceCertificateResource, currentValue: AppServiceCertificateResource, currentIndex: number, array: AppServiceCertificateResource[]): AppServiceCertificateResource
    - Parameters
      - previousValue: AppServiceCertificateResource
      - currentValue: AppServiceCertificateResource
      - currentIndex: number
      - array: AppServiceCertificateResource[]
      Returns AppServiceCertificateResource
Returns AppServiceCertificateResource
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: AppServiceCertificateResource, currentValue: AppServiceCertificateResource, currentIndex: number, array: AppServiceCertificateResource[]): AppServiceCertificateResource
    - Parameters
      - previousValue: AppServiceCertificateResource
      - currentValue: AppServiceCertificateResource
      - currentIndex: number
      - array: AppServiceCertificateResource[]
      Returns AppServiceCertificateResource
- initialValue: AppServiceCertificateResource
Returns AppServiceCertificateResource
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: AppServiceCertificateResource, currentIndex: number, array: AppServiceCertificateResource[]): U
    - Parameters
      - previousValue: U
      - currentValue: AppServiceCertificateResource
      - currentIndex: number
      - array: AppServiceCertificateResource[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): AppServiceCertificateResource
reduceRight(callbackfn: function, initialValue: AppServiceCertificateResource): AppServiceCertificateResource
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: AppServiceCertificateResource, currentValue: AppServiceCertificateResource, currentIndex: number, array: AppServiceCertificateResource[]): AppServiceCertificateResource
    - Parameters
      - previousValue: AppServiceCertificateResource
      - currentValue: AppServiceCertificateResource
      - currentIndex: number
      - array: AppServiceCertificateResource[]
      Returns AppServiceCertificateResource
Returns AppServiceCertificateResource
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: AppServiceCertificateResource, currentValue: AppServiceCertificateResource, currentIndex: number, array: AppServiceCertificateResource[]): AppServiceCertificateResource
    - Parameters
      - previousValue: AppServiceCertificateResource
      - currentValue: AppServiceCertificateResource
      - currentIndex: number
      - array: AppServiceCertificateResource[]
      Returns AppServiceCertificateResource
- initialValue: AppServiceCertificateResource
Returns AppServiceCertificateResource
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: AppServiceCertificateResource, currentIndex: number, array: AppServiceCertificateResource[]): U
    - Parameters
      - previousValue: U
      - currentValue: AppServiceCertificateResource
      - currentIndex: number
      - array: AppServiceCertificateResource[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): AppServiceCertificateResource[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns AppServiceCertificateResource[]

shift

shift(): AppServiceCertificateResource | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns AppServiceCertificateResource | undefined

slice

slice(start?: undefined | number, end?: undefined | number): AppServiceCertificateResource[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns AppServiceCertificateResource[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: AppServiceCertificateResource, index: number, array: AppServiceCertificateResource[]): boolean
    - Parameters
      - value: AppServiceCertificateResource
      - index: number
      - array: AppServiceCertificateResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): AppServiceCertificateResource[]
splice(start: number, deleteCount: number, ...items: AppServiceCertificateResource[]): AppServiceCertificateResource[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns AppServiceCertificateResource[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: AppServiceCertificateResource[]
  
  Elements to insert into the array in place of the deleted elements.
Returns AppServiceCertificateResource[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: AppServiceCertificateResource[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: AppServiceCertificateResource[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<AppServiceCertificateResource>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<AppServiceCertificateResource>

type

type: object

className

className: string = "AppServiceCertificateCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "AppServiceCertificateResource"

name

Const AppServiceCertificateOrder

AppServiceCertificateOrder: object

interface: An interface representing AppServiceCertificateOrder. SSL certificate purchase order.
extends: Resource

Optional appServiceCertificateNotRenewableReasons

appServiceCertificateNotRenewableReasons: string[]

member: {string[]} [appServiceCertificateNotRenewableReasons] Reasons why App Service Certificate is not renewable at the current moment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional autoRenew

autoRenew: undefined | false | true

member: {boolean} [autoRenew] true if the certificate should be automatically renewed when it expires; otherwise, false. Default value: true .

Optional certificates

certificates: undefined | object

member: {{ [propertyName: string]: AppServiceCertificate }} [certificates] State of the Key Vault secret.

Optional csr

csr: undefined | string

member: {string} [csr] Last CSR that was created for this order.

Optional distinguishedName

distinguishedName: undefined | string

member: {string} [distinguishedName] Certificate distinguished name.

Optional domainVerificationToken

domainVerificationToken: undefined | string

member: {string} [domainVerificationToken] Domain verification token. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expirationTime

expirationTime: Date

member: {Date} [expirationTime] Certificate expiration time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional intermediate

intermediate: CertificateDetails

member: {CertificateDetails} [intermediate] Intermediate certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isPrivateKeyExternal

isPrivateKeyExternal: undefined | false | true

member: {boolean} [isPrivateKeyExternal] true if private key is external; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional keySize

keySize: undefined | number

member: {number} [keySize] Certificate key size. Default value: 2048 .

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional lastCertificateIssuanceTime

lastCertificateIssuanceTime: Date

member: {Date} [lastCertificateIssuanceTime] Certificate last issuance time. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

member: {string} location Resource Location.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextAutoRenewalTimeStamp

nextAutoRenewalTimeStamp: Date

member: {Date} [nextAutoRenewalTimeStamp] Time stamp when the certificate would be auto renewed next NOTE: This property will not be serialized. It can only be populated by the server.

productType

productType: CertificateProductType

member: {CertificateProductType} productType Certificate product type. Possible values include: 'StandardDomainValidatedSsl', 'StandardDomainValidatedWildCardSsl'

Optional provisioningState

provisioningState: ProvisioningState

member: {ProvisioningState} [provisioningState] Status of certificate order. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional root

root: CertificateDetails

member: {CertificateDetails} [root] Root certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional serialNumber

serialNumber: undefined | string

member: {string} [serialNumber] Current serial number of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceCertificateOrder"

Optional signedCertificate

signedCertificate: CertificateDetails

member: {CertificateDetails} [signedCertificate] Signed certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: CertificateOrderStatus

member: {CertificateOrderStatus} [status] Current order status. Possible values include: 'Pendingissuance', 'Issued', 'Revoked', 'Canceled', 'Denied', 'Pendingrevocation', 'PendingRekey', 'Unused', 'Expired', 'NotSubmitted' NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

member: {{ [propertyName: string]: string }} [tags] Resource tags.

Optional validityInYears

validityInYears: undefined | number

member: {number} [validityInYears] Duration in years (must be between 1 and 3). Default value: 1 .

type

type: object

className

className: string = "AppServiceCertificateOrder"

name

modelProperties

modelProperties: object

appServiceCertificateNotRenewableReasons

appServiceCertificateNotRenewableReasons: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.appServiceCertificateNotRenewableReasons"

type

type: object

name

element

element: object

type

type: object

name

autoRenew

type

type: object

name

expirationTime

expirationTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.expirationTime"

type

type: object

name

intermediate

allowedValues

allowedValues: string[] = ["StandardDomainValidatedSsl","StandardDomainValidatedWildCardSsl"]

name

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

name

root

className

className: string = "CertificateDetails"

name

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["Pendingissuance","Issued","Revoked","Canceled","Denied","Pendingrevocation","PendingRekey","Unused","Expired","NotSubmitted"]

name

validityInYears

validityInYears: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "properties.validityInYears"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 3

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const AppServiceCertificateOrderCollection

AppServiceCertificateOrderCollection: object

interface: An interface representing the AppServiceCertificateOrderCollection. Collection of certitificate orders.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceCertificateOrderCollection"

__@iterator

__@iterator(): IterableIterator<AppServiceCertificateOrder>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<AppServiceCertificateOrder>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<AppServiceCertificateOrder>[]): AppServiceCertificateOrder[]
concat(...items: (T | ConcatArray<T>)[]): AppServiceCertificateOrder[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<AppServiceCertificateOrder>[]
 
 Additional items to add to the end of array1.
Returns AppServiceCertificateOrder[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns AppServiceCertificateOrder[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, AppServiceCertificateOrder]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, AppServiceCertificateOrder]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: AppServiceCertificateOrder, index: number, array: AppServiceCertificateOrder[]): boolean
    - Parameters
      - value: AppServiceCertificateOrder
      - index: number
      - array: AppServiceCertificateOrder[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: AppServiceCertificateOrder, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: AppServiceCertificateOrder
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): AppServiceCertificateOrder[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: AppServiceCertificateOrder
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceCertificateOrder, index: number, array: AppServiceCertificateOrder[]): boolean
    - Parameters
      - value: AppServiceCertificateOrder
      - index: number
      - array: AppServiceCertificateOrder[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceCertificateOrder, index: number, array: AppServiceCertificateOrder[]): any
    - Parameters
      - value: AppServiceCertificateOrder
      - index: number
      - array: AppServiceCertificateOrder[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns AppServiceCertificateOrder[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): AppServiceCertificateOrder | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: AppServiceCertificateOrder
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: AppServiceCertificateOrder, index: number, obj: AppServiceCertificateOrder[]): boolean
    - Parameters
      - this: void
      - value: AppServiceCertificateOrder
      - index: number
      - obj: AppServiceCertificateOrder[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: AppServiceCertificateOrder, index: number, obj: AppServiceCertificateOrder[]): boolean
    - Parameters
      - value: AppServiceCertificateOrder
      - index: number
      - obj: AppServiceCertificateOrder[]
      Returns boolean
- Optional thisArg: any
Returns AppServiceCertificateOrder | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: AppServiceCertificateOrder, index: number, obj: AppServiceCertificateOrder[]): boolean
    - Parameters
      - value: AppServiceCertificateOrder
      - index: number
      - obj: AppServiceCertificateOrder[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceCertificateOrder, index: number, array: AppServiceCertificateOrder[]): void
    - Parameters
      - value: AppServiceCertificateOrder
      - index: number
      - array: AppServiceCertificateOrder[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: AppServiceCertificateOrder, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: AppServiceCertificateOrder
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: AppServiceCertificateOrder, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: AppServiceCertificateOrder
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: AppServiceCertificateOrder, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: AppServiceCertificateOrder
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceCertificateOrder, index: number, array: AppServiceCertificateOrder[]): U
    - Parameters
      - value: AppServiceCertificateOrder
      - index: number
      - array: AppServiceCertificateOrder[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): AppServiceCertificateOrder | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns AppServiceCertificateOrder | undefined

push

push(...items: AppServiceCertificateOrder[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: AppServiceCertificateOrder[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): AppServiceCertificateOrder
reduce(callbackfn: function, initialValue: AppServiceCertificateOrder): AppServiceCertificateOrder
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: AppServiceCertificateOrder, currentValue: AppServiceCertificateOrder, currentIndex: number, array: AppServiceCertificateOrder[]): AppServiceCertificateOrder
    - Parameters
      - previousValue: AppServiceCertificateOrder
      - currentValue: AppServiceCertificateOrder
      - currentIndex: number
      - array: AppServiceCertificateOrder[]
      Returns AppServiceCertificateOrder
Returns AppServiceCertificateOrder
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: AppServiceCertificateOrder, currentValue: AppServiceCertificateOrder, currentIndex: number, array: AppServiceCertificateOrder[]): AppServiceCertificateOrder
    - Parameters
      - previousValue: AppServiceCertificateOrder
      - currentValue: AppServiceCertificateOrder
      - currentIndex: number
      - array: AppServiceCertificateOrder[]
      Returns AppServiceCertificateOrder
- initialValue: AppServiceCertificateOrder
Returns AppServiceCertificateOrder
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: AppServiceCertificateOrder, currentIndex: number, array: AppServiceCertificateOrder[]): U
    - Parameters
      - previousValue: U
      - currentValue: AppServiceCertificateOrder
      - currentIndex: number
      - array: AppServiceCertificateOrder[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): AppServiceCertificateOrder
reduceRight(callbackfn: function, initialValue: AppServiceCertificateOrder): AppServiceCertificateOrder
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: AppServiceCertificateOrder, currentValue: AppServiceCertificateOrder, currentIndex: number, array: AppServiceCertificateOrder[]): AppServiceCertificateOrder
    - Parameters
      - previousValue: AppServiceCertificateOrder
      - currentValue: AppServiceCertificateOrder
      - currentIndex: number
      - array: AppServiceCertificateOrder[]
      Returns AppServiceCertificateOrder
Returns AppServiceCertificateOrder
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: AppServiceCertificateOrder, currentValue: AppServiceCertificateOrder, currentIndex: number, array: AppServiceCertificateOrder[]): AppServiceCertificateOrder
    - Parameters
      - previousValue: AppServiceCertificateOrder
      - currentValue: AppServiceCertificateOrder
      - currentIndex: number
      - array: AppServiceCertificateOrder[]
      Returns AppServiceCertificateOrder
- initialValue: AppServiceCertificateOrder
Returns AppServiceCertificateOrder
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: AppServiceCertificateOrder, currentIndex: number, array: AppServiceCertificateOrder[]): U
    - Parameters
      - previousValue: U
      - currentValue: AppServiceCertificateOrder
      - currentIndex: number
      - array: AppServiceCertificateOrder[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): AppServiceCertificateOrder[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns AppServiceCertificateOrder[]

shift

shift(): AppServiceCertificateOrder | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns AppServiceCertificateOrder | undefined

slice

slice(start?: undefined | number, end?: undefined | number): AppServiceCertificateOrder[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns AppServiceCertificateOrder[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: AppServiceCertificateOrder, index: number, array: AppServiceCertificateOrder[]): boolean
    - Parameters
      - value: AppServiceCertificateOrder
      - index: number
      - array: AppServiceCertificateOrder[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): AppServiceCertificateOrder[]
splice(start: number, deleteCount: number, ...items: AppServiceCertificateOrder[]): AppServiceCertificateOrder[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns AppServiceCertificateOrder[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: AppServiceCertificateOrder[]
  
  Elements to insert into the array in place of the deleted elements.
Returns AppServiceCertificateOrder[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: AppServiceCertificateOrder[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: AppServiceCertificateOrder[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<AppServiceCertificateOrder>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<AppServiceCertificateOrder>

type

type: object

className

className: string = "AppServiceCertificateOrderCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "AppServiceCertificateOrder"

name

Const AppServiceCertificateOrderPatchResource

AppServiceCertificateOrderPatchResource: object

interface: An interface representing AppServiceCertificateOrderPatchResource. ARM resource for a certificate order that is purchased through Azure.
extends: ProxyOnlyResource

Optional appServiceCertificateNotRenewableReasons

appServiceCertificateNotRenewableReasons: string[]

member: {string[]} [appServiceCertificateNotRenewableReasons] Reasons why App Service Certificate is not renewable at the current moment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional autoRenew

autoRenew: undefined | false | true

member: {boolean} [autoRenew] true if the certificate should be automatically renewed when it expires; otherwise, false. Default value: true .

Optional certificates

certificates: undefined | object

member: {{ [propertyName: string]: AppServiceCertificate }} [certificates] State of the Key Vault secret.

Optional csr

csr: undefined | string

member: {string} [csr] Last CSR that was created for this order.

Optional distinguishedName

distinguishedName: undefined | string

member: {string} [distinguishedName] Certificate distinguished name.

Optional domainVerificationToken

domainVerificationToken: undefined | string

member: {string} [domainVerificationToken] Domain verification token. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expirationTime

expirationTime: Date

member: {Date} [expirationTime] Certificate expiration time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional intermediate

intermediate: CertificateDetails

member: {CertificateDetails} [intermediate] Intermediate certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isPrivateKeyExternal

isPrivateKeyExternal: undefined | false | true

member: {boolean} [isPrivateKeyExternal] true if private key is external; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional keySize

keySize: undefined | number

member: {number} [keySize] Certificate key size. Default value: 2048 .

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional lastCertificateIssuanceTime

lastCertificateIssuanceTime: Date

member: {Date} [lastCertificateIssuanceTime] Certificate last issuance time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextAutoRenewalTimeStamp

nextAutoRenewalTimeStamp: Date

member: {Date} [nextAutoRenewalTimeStamp] Time stamp when the certificate would be auto renewed next NOTE: This property will not be serialized. It can only be populated by the server.

productType

productType: CertificateProductType

member: {CertificateProductType} productType Certificate product type. Possible values include: 'StandardDomainValidatedSsl', 'StandardDomainValidatedWildCardSsl'

Optional provisioningState

provisioningState: ProvisioningState

member: {ProvisioningState} [provisioningState] Status of certificate order. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional root

root: CertificateDetails

member: {CertificateDetails} [root] Root certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional serialNumber

serialNumber: undefined | string

member: {string} [serialNumber] Current serial number of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceCertificateOrderPatchResource"

Optional signedCertificate

signedCertificate: CertificateDetails

member: {CertificateDetails} [signedCertificate] Signed certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: CertificateOrderStatus

member: {CertificateOrderStatus} [status] Current order status. Possible values include: 'Pendingissuance', 'Issued', 'Revoked', 'Canceled', 'Denied', 'Pendingrevocation', 'PendingRekey', 'Unused', 'Expired', 'NotSubmitted' NOTE: This property will not be serialized. It can only be populated by the server.

Optional validityInYears

validityInYears: undefined | number

member: {number} [validityInYears] Duration in years (must be between 1 and 3). Default value: 1 .

type

type: object

className

className: string = "AppServiceCertificateOrderPatchResource"

name

modelProperties

modelProperties: object

appServiceCertificateNotRenewableReasons

appServiceCertificateNotRenewableReasons: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.appServiceCertificateNotRenewableReasons"

type

type: object

name

element

element: object

type

type: object

name

autoRenew

type

type: object

name

expirationTime

expirationTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.expirationTime"

type

type: object

name

intermediate

allowedValues

allowedValues: string[] = ["StandardDomainValidatedSsl","StandardDomainValidatedWildCardSsl"]

name

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

name

root

className

className: string = "CertificateDetails"

name

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

allowedValues

allowedValues: string[] = ["Pendingissuance","Issued","Revoked","Canceled","Denied","Pendingrevocation","PendingRekey","Unused","Expired","NotSubmitted"]

name

validityInYears

validityInYears: object

defaultValue

defaultValue: number = 1

serializedName

serializedName: string = "properties.validityInYears"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 3

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const AppServiceCertificatePatchResource

AppServiceCertificatePatchResource: object

interface: An interface representing AppServiceCertificatePatchResource. Key Vault container ARM resource for a certificate that is purchased through Azure.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional keyVaultId

keyVaultId: undefined | string

member: {string} [keyVaultId] Key Vault resource Id.

Optional keyVaultSecretName

keyVaultSecretName: undefined | string

member: {string} [keyVaultSecretName] Key Vault secret name.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: KeyVaultSecretStatus

member: {KeyVaultSecretStatus} [provisioningState] Status of the Key Vault secret. Possible values include: 'Initialized', 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceCertificatePatchResource"

type

type: object

className

className: string = "AppServiceCertificatePatchResource"

name

modelProperties

type

type: object

allowedValues

name

Const AppServiceCertificateResource

AppServiceCertificateResource: object

interface: An interface representing AppServiceCertificateResource. Key Vault container ARM resource for a certificate that is purchased through Azure.
extends: Resource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional keyVaultId

keyVaultId: undefined | string

member: {string} [keyVaultId] Key Vault resource Id.

Optional keyVaultSecretName

keyVaultSecretName: undefined | string

member: {string} [keyVaultSecretName] Key Vault secret name.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

location

location: string

member: {string} location Resource Location.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: KeyVaultSecretStatus

member: {KeyVaultSecretStatus} [provisioningState] Status of the Key Vault secret. Possible values include: 'Initialized', 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceCertificateResource"

Optional tags

tags: undefined | object

member: {{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

className

className: string = "AppServiceCertificateResource"

name

modelProperties

type

type: object

allowedValues

name

Const AppServiceEnvironment

AppServiceEnvironment: object

interface: An interface representing AppServiceEnvironment. Description of an App Service Environment.

Optional allowedMultiSizes

allowedMultiSizes: undefined | string

member: {string} [allowedMultiSizes] List of comma separated strings describing which VM sizes are allowed for front-ends. NOTE: This property will not be serialized. It can only be populated by the server.

Optional allowedWorkerSizes

allowedWorkerSizes: undefined | string

member: {string} [allowedWorkerSizes] List of comma separated strings describing which VM sizes are allowed for workers. NOTE: This property will not be serialized. It can only be populated by the server.

Optional apiManagementAccountId

apiManagementAccountId: undefined | string

member: {string} [apiManagementAccountId] API Management Account associated with the App Service Environment.

Optional clusterSettings

clusterSettings: NameValuePair[]

member: {NameValuePair[]} [clusterSettings] Custom settings for changing the behavior of the App Service Environment.

Optional databaseEdition

databaseEdition: undefined | string

member: {string} [databaseEdition] Edition of the metadata database for the App Service Environment, e.g. "Standard". NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseServiceObjective

databaseServiceObjective: undefined | string

member: {string} [databaseServiceObjective] Service objective of the metadata database for the App Service Environment, e.g. "S0". NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultFrontEndScaleFactor

defaultFrontEndScaleFactor: undefined | number

member: {number} [defaultFrontEndScaleFactor] Default Scale Factor for FrontEnds. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dnsSuffix

dnsSuffix: undefined | string

member: {string} [dnsSuffix] DNS suffix of the App Service Environment.

Optional dynamicCacheEnabled

dynamicCacheEnabled: undefined | false | true

member: {boolean} [dynamicCacheEnabled] True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

Optional environmentCapacities

environmentCapacities: StampCapacity[]

member: {StampCapacity[]} [environmentCapacities] Current total, used, and available worker capacities. NOTE: This property will not be serialized. It can only be populated by the server.

Optional environmentIsHealthy

environmentIsHealthy: undefined | false | true

member: {boolean} [environmentIsHealthy] True/false indicating whether the App Service Environment is healthy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional environmentStatus

environmentStatus: undefined | string

member: {string} [environmentStatus] Detailed message about with results of the last check of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional frontEndScaleFactor

frontEndScaleFactor: undefined | number

member: {number} [frontEndScaleFactor] Scale factor for front-ends.

Optional hasLinuxWorkers

hasLinuxWorkers: undefined | false | true

member: {boolean} [hasLinuxWorkers] Flag that displays whether an ASE has linux workers or not

Optional internalLoadBalancingMode

internalLoadBalancingMode: InternalLoadBalancingMode

member: {InternalLoadBalancingMode} [internalLoadBalancingMode] Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: 'None', 'Web', 'Publishing'

Optional ipsslAddressCount

ipsslAddressCount: undefined | number

member: {number} [ipsslAddressCount] Number of IP SSL addresses reserved for the App Service Environment.

Optional lastAction

lastAction: undefined | string

member: {string} [lastAction] Last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastActionResult

lastActionResult: undefined | string

member: {string} [lastActionResult] Result of the last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

member: {string} location Location of the App Service Environment, e.g. "West US".

Optional maximumNumberOfMachines

maximumNumberOfMachines: undefined | number

member: {number} [maximumNumberOfMachines] Maximum number of VMs in the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional multiRoleCount

multiRoleCount: undefined | number

member: {number} [multiRoleCount] Number of front-end instances.

Optional multiSize

multiSize: undefined | string

member: {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".

name

member: {string} name Name of the App Service Environment.

Optional networkAccessControlList

networkAccessControlList: NetworkAccessControlEntry[]

member: {NetworkAccessControlEntry[]} [networkAccessControlList] Access control list for controlling traffic to the App Service Environment.

Optional provisioningState

provisioningState: ProvisioningState

member: {ProvisioningState} [provisioningState] Provisioning state of the App Service Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGroup

resourceGroup: undefined | string

member: {string} [resourceGroup] Resource group of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceEnvironment"

Optional sslCertKeyVaultId

sslCertKeyVaultId: undefined | string

member: {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service Environment default SSL certificate

Optional sslCertKeyVaultSecretName

sslCertKeyVaultSecretName: undefined | string

member: {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for ILB App Service Environment default SSL certificate

Optional status

status: HostingEnvironmentStatus

member: {HostingEnvironmentStatus} [status] Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscriptionId

subscriptionId: undefined | string

member: {string} [subscriptionId] Subscription of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional suspended

suspended: undefined | false | true

member: {boolean} [suspended] true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

Optional upgradeDomains

upgradeDomains: undefined | number

member: {number} [upgradeDomains] Number of upgrade domains of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional userWhitelistedIpRanges

userWhitelistedIpRanges: string[]

member: {string[]} [userWhitelistedIpRanges] User added ip ranges to whitelist on ASE db

Optional vipMappings

vipMappings: VirtualIPMapping[]

member: {VirtualIPMapping[]} [vipMappings] Description of IP SSL mapping for the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

virtualNetwork

virtualNetwork: VirtualNetworkProfile

member: {VirtualNetworkProfile} virtualNetwork Description of the Virtual Network.

Optional vnetName

vnetName: undefined | string

member: {string} [vnetName] Name of the Virtual Network for the App Service Environment.

Optional vnetResourceGroupName

vnetResourceGroupName: undefined | string

member: {string} [vnetResourceGroupName] Resource group of the Virtual Network.

Optional vnetSubnetName

vnetSubnetName: undefined | string

member: {string} [vnetSubnetName] Subnet of the Virtual Network.

workerPools

workerPools: WorkerPool[]

member: {WorkerPool[]} workerPools Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.

type

type: object

className

className: string = "AppServiceEnvironment"

name

modelProperties

modelProperties: object

allowedMultiSizes

allowedMultiSizes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "allowedMultiSizes"

type

type: object

name

allowedWorkerSizes

type

type: object

name

databaseServiceObjective

databaseServiceObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "databaseServiceObjective"

type

type: object

name

defaultFrontEndScaleFactor

type

type: object

name

element

element: object

type

type: object

className

className: string = "StampCapacity"

name

environmentIsHealthy

environmentIsHealthy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "environmentIsHealthy"

type

type: object

name

environmentStatus

allowedValues

allowedValues: string[] = ["None","Web","Publishing"]

multiRoleCount: object

serializedName

serializedName: string = "multiRoleCount"

type

type: object

name

multiSize

multiSize: object

serializedName

serializedName: string = "multiSize"

type

type: object

serializedName: string = "provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

name

resourceGroup

type

type: object

allowedValues

allowedValues: string[] = ["Preparing","Ready","Scaling","Deleting"]

name

subscriptionId

type

type: object

required

required: true = true

serializedName

serializedName: string = "workerPools"

type

type: object

name

element

element: object

type

type: object

className

className: string = "WorkerPool"

name

Const AppServiceEnvironmentCollection

AppServiceEnvironmentCollection: object

interface: An interface representing the AppServiceEnvironmentCollection. Collection of App Service Environments.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceEnvironmentCollection"

__@iterator

__@iterator(): IterableIterator<AppServiceEnvironmentResource>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<AppServiceEnvironmentResource>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<AppServiceEnvironmentResource>[]): AppServiceEnvironmentResource[]
concat(...items: (T | ConcatArray<T>)[]): AppServiceEnvironmentResource[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<AppServiceEnvironmentResource>[]
 
 Additional items to add to the end of array1.
Returns AppServiceEnvironmentResource[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns AppServiceEnvironmentResource[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, AppServiceEnvironmentResource]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, AppServiceEnvironmentResource]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: AppServiceEnvironmentResource, index: number, array: AppServiceEnvironmentResource[]): boolean
    - Parameters
      - value: AppServiceEnvironmentResource
      - index: number
      - array: AppServiceEnvironmentResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: AppServiceEnvironmentResource, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: AppServiceEnvironmentResource
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): AppServiceEnvironmentResource[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: AppServiceEnvironmentResource
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceEnvironmentResource, index: number, array: AppServiceEnvironmentResource[]): boolean
    - Parameters
      - value: AppServiceEnvironmentResource
      - index: number
      - array: AppServiceEnvironmentResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceEnvironmentResource, index: number, array: AppServiceEnvironmentResource[]): any
    - Parameters
      - value: AppServiceEnvironmentResource
      - index: number
      - array: AppServiceEnvironmentResource[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns AppServiceEnvironmentResource[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): AppServiceEnvironmentResource | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: AppServiceEnvironmentResource
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: AppServiceEnvironmentResource, index: number, obj: AppServiceEnvironmentResource[]): boolean
    - Parameters
      - this: void
      - value: AppServiceEnvironmentResource
      - index: number
      - obj: AppServiceEnvironmentResource[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: AppServiceEnvironmentResource, index: number, obj: AppServiceEnvironmentResource[]): boolean
    - Parameters
      - value: AppServiceEnvironmentResource
      - index: number
      - obj: AppServiceEnvironmentResource[]
      Returns boolean
- Optional thisArg: any
Returns AppServiceEnvironmentResource | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: AppServiceEnvironmentResource, index: number, obj: AppServiceEnvironmentResource[]): boolean
    - Parameters
      - value: AppServiceEnvironmentResource
      - index: number
      - obj: AppServiceEnvironmentResource[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceEnvironmentResource, index: number, array: AppServiceEnvironmentResource[]): void
    - Parameters
      - value: AppServiceEnvironmentResource
      - index: number
      - array: AppServiceEnvironmentResource[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: AppServiceEnvironmentResource, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: AppServiceEnvironmentResource
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: AppServiceEnvironmentResource, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: AppServiceEnvironmentResource
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: AppServiceEnvironmentResource, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: AppServiceEnvironmentResource
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: AppServiceEnvironmentResource, index: number, array: AppServiceEnvironmentResource[]): U
    - Parameters
      - value: AppServiceEnvironmentResource
      - index: number
      - array: AppServiceEnvironmentResource[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): AppServiceEnvironmentResource | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns AppServiceEnvironmentResource | undefined

push

push(...items: AppServiceEnvironmentResource[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: AppServiceEnvironmentResource[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): AppServiceEnvironmentResource
reduce(callbackfn: function, initialValue: AppServiceEnvironmentResource): AppServiceEnvironmentResource
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: AppServiceEnvironmentResource, currentValue: AppServiceEnvironmentResource, currentIndex: number, array: AppServiceEnvironmentResource[]): AppServiceEnvironmentResource
    - Parameters
      - previousValue: AppServiceEnvironmentResource
      - currentValue: AppServiceEnvironmentResource
      - currentIndex: number
      - array: AppServiceEnvironmentResource[]
      Returns AppServiceEnvironmentResource
Returns AppServiceEnvironmentResource
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: AppServiceEnvironmentResource, currentValue: AppServiceEnvironmentResource, currentIndex: number, array: AppServiceEnvironmentResource[]): AppServiceEnvironmentResource
    - Parameters
      - previousValue: AppServiceEnvironmentResource
      - currentValue: AppServiceEnvironmentResource
      - currentIndex: number
      - array: AppServiceEnvironmentResource[]
      Returns AppServiceEnvironmentResource
- initialValue: AppServiceEnvironmentResource
Returns AppServiceEnvironmentResource
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: AppServiceEnvironmentResource, currentIndex: number, array: AppServiceEnvironmentResource[]): U
    - Parameters
      - previousValue: U
      - currentValue: AppServiceEnvironmentResource
      - currentIndex: number
      - array: AppServiceEnvironmentResource[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): AppServiceEnvironmentResource
reduceRight(callbackfn: function, initialValue: AppServiceEnvironmentResource): AppServiceEnvironmentResource
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: AppServiceEnvironmentResource, currentValue: AppServiceEnvironmentResource, currentIndex: number, array: AppServiceEnvironmentResource[]): AppServiceEnvironmentResource
    - Parameters
      - previousValue: AppServiceEnvironmentResource
      - currentValue: AppServiceEnvironmentResource
      - currentIndex: number
      - array: AppServiceEnvironmentResource[]
      Returns AppServiceEnvironmentResource
Returns AppServiceEnvironmentResource
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: AppServiceEnvironmentResource, currentValue: AppServiceEnvironmentResource, currentIndex: number, array: AppServiceEnvironmentResource[]): AppServiceEnvironmentResource
    - Parameters
      - previousValue: AppServiceEnvironmentResource
      - currentValue: AppServiceEnvironmentResource
      - currentIndex: number
      - array: AppServiceEnvironmentResource[]
      Returns AppServiceEnvironmentResource
- initialValue: AppServiceEnvironmentResource
Returns AppServiceEnvironmentResource
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: AppServiceEnvironmentResource, currentIndex: number, array: AppServiceEnvironmentResource[]): U
    - Parameters
      - previousValue: U
      - currentValue: AppServiceEnvironmentResource
      - currentIndex: number
      - array: AppServiceEnvironmentResource[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): AppServiceEnvironmentResource[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns AppServiceEnvironmentResource[]

shift

shift(): AppServiceEnvironmentResource | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns AppServiceEnvironmentResource | undefined

slice

slice(start?: undefined | number, end?: undefined | number): AppServiceEnvironmentResource[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns AppServiceEnvironmentResource[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: AppServiceEnvironmentResource, index: number, array: AppServiceEnvironmentResource[]): boolean
    - Parameters
      - value: AppServiceEnvironmentResource
      - index: number
      - array: AppServiceEnvironmentResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): AppServiceEnvironmentResource[]
splice(start: number, deleteCount: number, ...items: AppServiceEnvironmentResource[]): AppServiceEnvironmentResource[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns AppServiceEnvironmentResource[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: AppServiceEnvironmentResource[]
  
  Elements to insert into the array in place of the deleted elements.
Returns AppServiceEnvironmentResource[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: AppServiceEnvironmentResource[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: AppServiceEnvironmentResource[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<AppServiceEnvironmentResource>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<AppServiceEnvironmentResource>

type

type: object

className

className: string = "AppServiceEnvironmentCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "AppServiceEnvironmentResource"

name

Const AppServiceEnvironmentPatchResource

AppServiceEnvironmentPatchResource: object

interface: An interface representing AppServiceEnvironmentPatchResource. ARM resource for a app service enviroment.
extends: ProxyOnlyResource

Optional allowedMultiSizes

allowedMultiSizes: undefined | string

member: {string} [allowedMultiSizes] List of comma separated strings describing which VM sizes are allowed for front-ends. NOTE: This property will not be serialized. It can only be populated by the server.

Optional allowedWorkerSizes

allowedWorkerSizes: undefined | string

member: {string} [allowedWorkerSizes] List of comma separated strings describing which VM sizes are allowed for workers. NOTE: This property will not be serialized. It can only be populated by the server.

Optional apiManagementAccountId

apiManagementAccountId: undefined | string

member: {string} [apiManagementAccountId] API Management Account associated with the App Service Environment.

appServiceEnvironmentPatchResourceName

appServiceEnvironmentPatchResourceName: string

member: {string} appServiceEnvironmentPatchResourceName Name of the App Service Environment.

Optional clusterSettings

clusterSettings: NameValuePair[]

member: {NameValuePair[]} [clusterSettings] Custom settings for changing the behavior of the App Service Environment.

Optional databaseEdition

databaseEdition: undefined | string

member: {string} [databaseEdition] Edition of the metadata database for the App Service Environment, e.g. "Standard". NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseServiceObjective

databaseServiceObjective: undefined | string

member: {string} [databaseServiceObjective] Service objective of the metadata database for the App Service Environment, e.g. "S0". NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultFrontEndScaleFactor

defaultFrontEndScaleFactor: undefined | number

member: {number} [defaultFrontEndScaleFactor] Default Scale Factor for FrontEnds. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dnsSuffix

dnsSuffix: undefined | string

member: {string} [dnsSuffix] DNS suffix of the App Service Environment.

Optional dynamicCacheEnabled

dynamicCacheEnabled: undefined | false | true

member: {boolean} [dynamicCacheEnabled] True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

Optional environmentCapacities

environmentCapacities: StampCapacity[]

member: {StampCapacity[]} [environmentCapacities] Current total, used, and available worker capacities. NOTE: This property will not be serialized. It can only be populated by the server.

Optional environmentIsHealthy

environmentIsHealthy: undefined | false | true

member: {boolean} [environmentIsHealthy] True/false indicating whether the App Service Environment is healthy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional environmentStatus

environmentStatus: undefined | string

member: {string} [environmentStatus] Detailed message about with results of the last check of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional frontEndScaleFactor

frontEndScaleFactor: undefined | number

member: {number} [frontEndScaleFactor] Scale factor for front-ends.

Optional hasLinuxWorkers

hasLinuxWorkers: undefined | false | true

member: {boolean} [hasLinuxWorkers] Flag that displays whether an ASE has linux workers or not

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional internalLoadBalancingMode

internalLoadBalancingMode: InternalLoadBalancingMode

member: {InternalLoadBalancingMode} [internalLoadBalancingMode] Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: 'None', 'Web', 'Publishing'

Optional ipsslAddressCount

ipsslAddressCount: undefined | number

member: {number} [ipsslAddressCount] Number of IP SSL addresses reserved for the App Service Environment.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional lastAction

lastAction: undefined | string

member: {string} [lastAction] Last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastActionResult

lastActionResult: undefined | string

member: {string} [lastActionResult] Result of the last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

member: {string} location Location of the App Service Environment, e.g. "West US".

Optional maximumNumberOfMachines

maximumNumberOfMachines: undefined | number

member: {number} [maximumNumberOfMachines] Maximum number of VMs in the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional multiRoleCount

multiRoleCount: undefined | number

member: {number} [multiRoleCount] Number of front-end instances.

Optional multiSize

multiSize: undefined | string

member: {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkAccessControlList

networkAccessControlList: NetworkAccessControlEntry[]

member: {NetworkAccessControlEntry[]} [networkAccessControlList] Access control list for controlling traffic to the App Service Environment.

Optional provisioningState

provisioningState: ProvisioningState

member: {ProvisioningState} [provisioningState] Provisioning state of the App Service Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGroup

resourceGroup: undefined | string

member: {string} [resourceGroup] Resource group of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceEnvironmentPatchResource"

Optional sslCertKeyVaultId

sslCertKeyVaultId: undefined | string

member: {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service Environment default SSL certificate

Optional sslCertKeyVaultSecretName

sslCertKeyVaultSecretName: undefined | string

member: {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for ILB App Service Environment default SSL certificate

Optional status

status: HostingEnvironmentStatus

member: {HostingEnvironmentStatus} [status] Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscriptionId

subscriptionId: undefined | string

member: {string} [subscriptionId] Subscription of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional suspended

suspended: undefined | false | true

member: {boolean} [suspended] true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

Optional upgradeDomains

upgradeDomains: undefined | number

member: {number} [upgradeDomains] Number of upgrade domains of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional userWhitelistedIpRanges

userWhitelistedIpRanges: string[]

member: {string[]} [userWhitelistedIpRanges] User added ip ranges to whitelist on ASE db

Optional vipMappings

vipMappings: VirtualIPMapping[]

member: {VirtualIPMapping[]} [vipMappings] Description of IP SSL mapping for the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

virtualNetwork

virtualNetwork: VirtualNetworkProfile

member: {VirtualNetworkProfile} virtualNetwork Description of the Virtual Network.

Optional vnetName

vnetName: undefined | string

member: {string} [vnetName] Name of the Virtual Network for the App Service Environment.

Optional vnetResourceGroupName

vnetResourceGroupName: undefined | string

member: {string} [vnetResourceGroupName] Resource group of the Virtual Network.

Optional vnetSubnetName

vnetSubnetName: undefined | string

member: {string} [vnetSubnetName] Subnet of the Virtual Network.

workerPools

workerPools: WorkerPool[]

member: {WorkerPool[]} workerPools Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.

type

type: object

className

className: string = "AppServiceEnvironmentPatchResource"

name

modelProperties

modelProperties: object

allowedMultiSizes

allowedMultiSizes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.allowedMultiSizes"

type

type: object

name

allowedWorkerSizes

serializedName

serializedName: string = "properties.databaseEdition"

type

type: object

name

databaseServiceObjective

databaseServiceObjective: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.databaseServiceObjective"

type

type: object

name

defaultFrontEndScaleFactor

type

type: object

name

element

element: object

type

type: object

className

className: string = "StampCapacity"

name

environmentIsHealthy

environmentIsHealthy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.environmentIsHealthy"

type

type: object

name

environmentStatus

allowedValues

allowedValues: string[] = ["None","Web","Publishing"]

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

name

resourceGroup

type

type: object

allowedValues

allowedValues: string[] = ["Preparing","Ready","Scaling","Deleting"]

name

subscriptionId

type

type: object

required

required: true = true

serializedName

serializedName: string = "properties.workerPools"

type

type: object

name

element

element: object

type

type: object

className

className: string = "WorkerPool"

name

Const AppServiceEnvironmentResource

AppServiceEnvironmentResource: object

interface: An interface representing AppServiceEnvironmentResource. App Service Environment ARM resource.
extends: Resource

Optional allowedMultiSizes

allowedMultiSizes: undefined | string

member: {string} [allowedMultiSizes] List of comma separated strings describing which VM sizes are allowed for front-ends. NOTE: This property will not be serialized. It can only be populated by the server.

Optional allowedWorkerSizes

allowedWorkerSizes: undefined | string

member: {string} [allowedWorkerSizes] List of comma separated strings describing which VM sizes are allowed for workers. NOTE: This property will not be serialized. It can only be populated by the server.

Optional apiManagementAccountId

apiManagementAccountId: undefined | string

member: {string} [apiManagementAccountId] API Management Account associated with the App Service Environment.

appServiceEnvironmentResourceLocation

appServiceEnvironmentResourceLocation: string

member: {string} appServiceEnvironmentResourceLocation Location of the App Service Environment, e.g. "West US".

appServiceEnvironmentResourceName

appServiceEnvironmentResourceName: string

member: {string} appServiceEnvironmentResourceName Name of the App Service Environment.

Optional clusterSettings

clusterSettings: NameValuePair[]

member: {NameValuePair[]} [clusterSettings] Custom settings for changing the behavior of the App Service Environment.

Optional databaseEdition

databaseEdition: undefined | string

member: {string} [databaseEdition] Edition of the metadata database for the App Service Environment, e.g. "Standard". NOTE: This property will not be serialized. It can only be populated by the server.

Optional databaseServiceObjective

databaseServiceObjective: undefined | string

member: {string} [databaseServiceObjective] Service objective of the metadata database for the App Service Environment, e.g. "S0". NOTE: This property will not be serialized. It can only be populated by the server.

Optional defaultFrontEndScaleFactor

defaultFrontEndScaleFactor: undefined | number

member: {number} [defaultFrontEndScaleFactor] Default Scale Factor for FrontEnds. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dnsSuffix

dnsSuffix: undefined | string

member: {string} [dnsSuffix] DNS suffix of the App Service Environment.

Optional dynamicCacheEnabled

dynamicCacheEnabled: undefined | false | true

member: {boolean} [dynamicCacheEnabled] True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

Optional environmentCapacities

environmentCapacities: StampCapacity[]

member: {StampCapacity[]} [environmentCapacities] Current total, used, and available worker capacities. NOTE: This property will not be serialized. It can only be populated by the server.

Optional environmentIsHealthy

environmentIsHealthy: undefined | false | true

member: {boolean} [environmentIsHealthy] True/false indicating whether the App Service Environment is healthy. NOTE: This property will not be serialized. It can only be populated by the server.

Optional environmentStatus

environmentStatus: undefined | string

member: {string} [environmentStatus] Detailed message about with results of the last check of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional frontEndScaleFactor

frontEndScaleFactor: undefined | number

member: {number} [frontEndScaleFactor] Scale factor for front-ends.

Optional hasLinuxWorkers

hasLinuxWorkers: undefined | false | true

member: {boolean} [hasLinuxWorkers] Flag that displays whether an ASE has linux workers or not

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional internalLoadBalancingMode

internalLoadBalancingMode: InternalLoadBalancingMode

member: {InternalLoadBalancingMode} [internalLoadBalancingMode] Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment. Possible values include: 'None', 'Web', 'Publishing'

Optional ipsslAddressCount

ipsslAddressCount: undefined | number

member: {number} [ipsslAddressCount] Number of IP SSL addresses reserved for the App Service Environment.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional lastAction

lastAction: undefined | string

member: {string} [lastAction] Last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastActionResult

lastActionResult: undefined | string

member: {string} [lastActionResult] Result of the last deployment action on the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

member: {string} location Resource Location.

Optional maximumNumberOfMachines

maximumNumberOfMachines: undefined | number

member: {number} [maximumNumberOfMachines] Maximum number of VMs in the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional multiRoleCount

multiRoleCount: undefined | number

member: {number} [multiRoleCount] Number of front-end instances.

Optional multiSize

multiSize: undefined | string

member: {string} [multiSize] Front-end VM size, e.g. "Medium", "Large".

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional networkAccessControlList

networkAccessControlList: NetworkAccessControlEntry[]

member: {NetworkAccessControlEntry[]} [networkAccessControlList] Access control list for controlling traffic to the App Service Environment.

Optional provisioningState

provisioningState: ProvisioningState

member: {ProvisioningState} [provisioningState] Provisioning state of the App Service Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGroup

resourceGroup: undefined | string

member: {string} [resourceGroup] Resource group of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServiceEnvironmentResource"

Optional sslCertKeyVaultId

sslCertKeyVaultId: undefined | string

member: {string} [sslCertKeyVaultId] Key Vault ID for ILB App Service Environment default SSL certificate

Optional sslCertKeyVaultSecretName

sslCertKeyVaultSecretName: undefined | string

member: {string} [sslCertKeyVaultSecretName] Key Vault Secret Name for ILB App Service Environment default SSL certificate

Optional status

status: HostingEnvironmentStatus

member: {HostingEnvironmentStatus} [status] Current status of the App Service Environment. Possible values include: 'Preparing', 'Ready', 'Scaling', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscriptionId

subscriptionId: undefined | string

member: {string} [subscriptionId] Subscription of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional suspended

suspended: undefined | false | true

member: {boolean} [suspended] true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).

Optional tags

tags: undefined | object

member: {{ [propertyName: string]: string }} [tags] Resource tags.

Optional upgradeDomains

upgradeDomains: undefined | number

member: {number} [upgradeDomains] Number of upgrade domains of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional userWhitelistedIpRanges

userWhitelistedIpRanges: string[]

member: {string[]} [userWhitelistedIpRanges] User added ip ranges to whitelist on ASE db

Optional vipMappings

vipMappings: VirtualIPMapping[]

member: {VirtualIPMapping[]} [vipMappings] Description of IP SSL mapping for the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

virtualNetwork

virtualNetwork: VirtualNetworkProfile

member: {VirtualNetworkProfile} virtualNetwork Description of the Virtual Network.

Optional vnetName

vnetName: undefined | string

member: {string} [vnetName] Name of the Virtual Network for the App Service Environment.

Optional vnetResourceGroupName

vnetResourceGroupName: undefined | string

member: {string} [vnetResourceGroupName] Resource group of the Virtual Network.

Optional vnetSubnetName

vnetSubnetName: undefined | string

member: {string} [vnetSubnetName] Subnet of the Virtual Network.

workerPools

workerPools: WorkerPool[]

member: {WorkerPool[]} workerPools Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.

type

type: object

className

className: string = "AppServiceEnvironmentResource"

name

modelProperties

modelProperties: object

allowedMultiSizes

allowedMultiSizes: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.allowedMultiSizes"

type

type: object

name

allowedWorkerSizes

type

type: object

name

appServiceEnvironmentResourceName

appServiceEnvironmentResourceName: object

required

required: true = true

serializedName

serializedName: string = "properties.name"

type

type: object

name

clusterSettings

clusterSettings: object

serializedName

serializedName: string = "properties.clusterSettings"

type

type: object

type

type: object

name

element

element: object

type

type: object

className

className: string = "StampCapacity"

name

environmentIsHealthy

environmentIsHealthy: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.environmentIsHealthy"

type

type: object

name

environmentStatus

allowedValues

allowedValues: string[] = ["None","Web","Publishing"]

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

name

resourceGroup

type

type: object

allowedValues

allowedValues: string[] = ["Preparing","Ready","Scaling","Deleting"]

name

subscriptionId

type

type: object

required

required: true = true

serializedName

serializedName: string = "properties.workerPools"

type

type: object

name

element

element: object

type

type: object

className

className: string = "WorkerPool"

name

Const AppServicePlan

AppServicePlan: object

interface: An interface representing AppServicePlan. App Service plan.
extends: Resource

Optional adminSiteName

adminSiteName: undefined | string

member: {string} [adminSiteName] App Service plan administration site.

Optional freeOfferExpirationTime

freeOfferExpirationTime: Date

member: {Date} [freeOfferExpirationTime] The time when the server farm free offer expires.

Optional geoRegion

geoRegion: undefined | string

member: {string} [geoRegion] Geographical location for the App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

member: {HostingEnvironmentProfile} [hostingEnvironmentProfile] Specification for the App Service Environment to use for the App Service plan.

Optional hyperV

hyperV: undefined | false | true

member: {boolean} [hyperV] If Hyper-V container app service plan true, false otherwise. Default value: false .

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isSpot

isSpot: undefined | false | true

member: {boolean} [isSpot] If true, this App Service Plan owns spot instances.

Optional isXenon

isXenon: undefined | false | true

member: {boolean} [isXenon] Obsolete: If Hyper-V container app service plan true, false otherwise. Default value: false .

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

location

location: string

member: {string} location Resource Location.

Optional maximumElasticWorkerCount

maximumElasticWorkerCount: undefined | number

member: {number} [maximumElasticWorkerCount] Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

Optional maximumNumberOfWorkers

maximumNumberOfWorkers: undefined | number

member: {number} [maximumNumberOfWorkers] Maximum number of instances that can be assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional numberOfSites

numberOfSites: undefined | number

member: {number} [numberOfSites] Number of apps assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional perSiteScaling

perSiteScaling: undefined | false | true

member: {boolean} [perSiteScaling] If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan. Default value: false .

Optional provisioningState

provisioningState: ProvisioningState

member: {ProvisioningState} [provisioningState] Provisioning state of the App Service Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional reserved

reserved: undefined | false | true

member: {boolean} [reserved] If Linux app service plan true, false otherwise. Default value: false .

Optional resourceGroup

resourceGroup: undefined | string

member: {string} [resourceGroup] Resource group of the App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServicePlan"

Optional sku

sku: SkuDescription

member: {SkuDescription} [sku]

Optional spotExpirationTime

spotExpirationTime: Date

member: {Date} [spotExpirationTime] The time when the server farm expires. Valid only if it is a spot server farm.

Optional status

status: StatusOptions

member: {StatusOptions} [status] App Service plan status. Possible values include: 'Ready', 'Pending', 'Creating' NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscription

subscription: undefined | string

member: {string} [subscription] App Service plan subscription. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

member: {{ [propertyName: string]: string }} [tags] Resource tags.

Optional targetWorkerCount

targetWorkerCount: undefined | number

member: {number} [targetWorkerCount] Scaling worker count.

Optional targetWorkerSizeId

targetWorkerSizeId: undefined | number

member: {number} [targetWorkerSizeId] Scaling worker size ID.

Optional workerTierName

workerTierName: undefined | string

member: {string} [workerTierName] Target worker tier assigned to the App Service plan.

type

type: object

className

className: string = "AppServicePlan"

name

modelProperties

type

type: object

name

hostingEnvironmentProfile

hostingEnvironmentProfile: object

serializedName

serializedName: string = "properties.hostingEnvironmentProfile"

type

type: object

className

className: string = "HostingEnvironmentProfile"

name

hyperV

type

type: object

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

targetWorkerSizeId: object

serializedName

serializedName: string = "properties.targetWorkerSizeId"

type

type: object

name

workerTierName

workerTierName: object

serializedName

serializedName: string = "properties.workerTierName"

type

type: object

name

Const AppServicePlanCollection

AppServicePlanCollection: object

interface: An interface representing the AppServicePlanCollection. Collection of App Service plans.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServicePlanCollection"

__@iterator

__@iterator(): IterableIterator<AppServicePlan>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<AppServicePlan>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<AppServicePlan>[]): AppServicePlan[]
concat(...items: (T | ConcatArray<T>)[]): AppServicePlan[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<AppServicePlan>[]
 
 Additional items to add to the end of array1.
Returns AppServicePlan[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns AppServicePlan[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, AppServicePlan]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, AppServicePlan]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: AppServicePlan, index: number, array: AppServicePlan[]): boolean
    - Parameters
      - value: AppServicePlan
      - index: number
      - array: AppServicePlan[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: AppServicePlan, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: AppServicePlan
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): AppServicePlan[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: AppServicePlan
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: AppServicePlan, index: number, array: AppServicePlan[]): boolean
    - Parameters
      - value: AppServicePlan
      - index: number
      - array: AppServicePlan[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: AppServicePlan, index: number, array: AppServicePlan[]): any
    - Parameters
      - value: AppServicePlan
      - index: number
      - array: AppServicePlan[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns AppServicePlan[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): AppServicePlan | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: AppServicePlan
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: AppServicePlan, index: number, obj: AppServicePlan[]): boolean
    - Parameters
      - this: void
      - value: AppServicePlan
      - index: number
      - obj: AppServicePlan[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: AppServicePlan, index: number, obj: AppServicePlan[]): boolean
    - Parameters
      - value: AppServicePlan
      - index: number
      - obj: AppServicePlan[]
      Returns boolean
- Optional thisArg: any
Returns AppServicePlan | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: AppServicePlan, index: number, obj: AppServicePlan[]): boolean
    - Parameters
      - value: AppServicePlan
      - index: number
      - obj: AppServicePlan[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: AppServicePlan, index: number, array: AppServicePlan[]): void
    - Parameters
      - value: AppServicePlan
      - index: number
      - array: AppServicePlan[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: AppServicePlan, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: AppServicePlan
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: AppServicePlan, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: AppServicePlan
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: AppServicePlan, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: AppServicePlan
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: AppServicePlan, index: number, array: AppServicePlan[]): U
    - Parameters
      - value: AppServicePlan
      - index: number
      - array: AppServicePlan[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): AppServicePlan | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns AppServicePlan | undefined

push

push(...items: AppServicePlan[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: AppServicePlan[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): AppServicePlan
reduce(callbackfn: function, initialValue: AppServicePlan): AppServicePlan
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: AppServicePlan, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): AppServicePlan
    - Parameters
      - previousValue: AppServicePlan
      - currentValue: AppServicePlan
      - currentIndex: number
      - array: AppServicePlan[]
      Returns AppServicePlan
Returns AppServicePlan
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: AppServicePlan, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): AppServicePlan
    - Parameters
      - previousValue: AppServicePlan
      - currentValue: AppServicePlan
      - currentIndex: number
      - array: AppServicePlan[]
      Returns AppServicePlan
- initialValue: AppServicePlan
Returns AppServicePlan
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): U
    - Parameters
      - previousValue: U
      - currentValue: AppServicePlan
      - currentIndex: number
      - array: AppServicePlan[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): AppServicePlan
reduceRight(callbackfn: function, initialValue: AppServicePlan): AppServicePlan
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: AppServicePlan, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): AppServicePlan
    - Parameters
      - previousValue: AppServicePlan
      - currentValue: AppServicePlan
      - currentIndex: number
      - array: AppServicePlan[]
      Returns AppServicePlan
Returns AppServicePlan
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: AppServicePlan, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): AppServicePlan
    - Parameters
      - previousValue: AppServicePlan
      - currentValue: AppServicePlan
      - currentIndex: number
      - array: AppServicePlan[]
      Returns AppServicePlan
- initialValue: AppServicePlan
Returns AppServicePlan
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: AppServicePlan, currentIndex: number, array: AppServicePlan[]): U
    - Parameters
      - previousValue: U
      - currentValue: AppServicePlan
      - currentIndex: number
      - array: AppServicePlan[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): AppServicePlan[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns AppServicePlan[]

shift

shift(): AppServicePlan | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns AppServicePlan | undefined

slice

slice(start?: undefined | number, end?: undefined | number): AppServicePlan[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns AppServicePlan[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: AppServicePlan, index: number, array: AppServicePlan[]): boolean
    - Parameters
      - value: AppServicePlan
      - index: number
      - array: AppServicePlan[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): AppServicePlan[]
splice(start: number, deleteCount: number, ...items: AppServicePlan[]): AppServicePlan[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns AppServicePlan[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: AppServicePlan[]
  
  Elements to insert into the array in place of the deleted elements.
Returns AppServicePlan[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: AppServicePlan[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: AppServicePlan[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<AppServicePlan>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<AppServicePlan>

type

type: object

className

className: string = "AppServicePlanCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "AppServicePlan"

name

Const AppServicePlanPatchResource

AppServicePlanPatchResource: object

interface: An interface representing AppServicePlanPatchResource. ARM resource for a app service plan.
extends: ProxyOnlyResource

Optional adminSiteName

adminSiteName: undefined | string

member: {string} [adminSiteName] App Service plan administration site.

Optional freeOfferExpirationTime

freeOfferExpirationTime: Date

member: {Date} [freeOfferExpirationTime] The time when the server farm free offer expires.

Optional geoRegion

geoRegion: undefined | string

member: {string} [geoRegion] Geographical location for the App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

member: {HostingEnvironmentProfile} [hostingEnvironmentProfile] Specification for the App Service Environment to use for the App Service plan.

Optional hyperV

hyperV: undefined | false | true

member: {boolean} [hyperV] If Hyper-V container app service plan true, false otherwise. Default value: false .

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isSpot

isSpot: undefined | false | true

member: {boolean} [isSpot] If true, this App Service Plan owns spot instances.

Optional isXenon

isXenon: undefined | false | true

member: {boolean} [isXenon] Obsolete: If Hyper-V container app service plan true, false otherwise. Default value: false .

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional maximumElasticWorkerCount

maximumElasticWorkerCount: undefined | number

member: {number} [maximumElasticWorkerCount] Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

Optional maximumNumberOfWorkers

maximumNumberOfWorkers: undefined | number

member: {number} [maximumNumberOfWorkers] Maximum number of instances that can be assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional numberOfSites

numberOfSites: undefined | number

member: {number} [numberOfSites] Number of apps assigned to this App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

Optional perSiteScaling

perSiteScaling: undefined | false | true

member: {boolean} [perSiteScaling] If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan. Default value: false .

Optional provisioningState

provisioningState: ProvisioningState

member: {ProvisioningState} [provisioningState] Provisioning state of the App Service Environment. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional reserved

reserved: undefined | false | true

member: {boolean} [reserved] If Linux app service plan true, false otherwise. Default value: false .

Optional resourceGroup

resourceGroup: undefined | string

member: {string} [resourceGroup] Resource group of the App Service plan. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "AppServicePlanPatchResource"

Optional spotExpirationTime

spotExpirationTime: Date

member: {Date} [spotExpirationTime] The time when the server farm expires. Valid only if it is a spot server farm.

Optional status

status: StatusOptions

member: {StatusOptions} [status] App Service plan status. Possible values include: 'Ready', 'Pending', 'Creating' NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscription

subscription: undefined | string

member: {string} [subscription] App Service plan subscription. NOTE: This property will not be serialized. It can only be populated by the server.

Optional targetWorkerCount

targetWorkerCount: undefined | number

member: {number} [targetWorkerCount] Scaling worker count.

Optional targetWorkerSizeId

targetWorkerSizeId: undefined | number

member: {number} [targetWorkerSizeId] Scaling worker size ID.

Optional workerTierName

workerTierName: undefined | string

member: {string} [workerTierName] Target worker tier assigned to the App Service plan.

type

type: object

className

className: string = "AppServicePlanPatchResource"

name

modelProperties

type

type: object

name

hostingEnvironmentProfile

hostingEnvironmentProfile: object

serializedName

serializedName: string = "properties.hostingEnvironmentProfile"

type

type: object

className

className: string = "HostingEnvironmentProfile"

name

hyperV

type

type: object

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

targetWorkerSizeId: object

serializedName

serializedName: string = "properties.targetWorkerSizeId"

type

type: object

name

workerTierName

workerTierName: object

serializedName

serializedName: string = "properties.workerTierName"

type

type: object

name

Const ApplicationLogsConfig

ApplicationLogsConfig: object

interface: An interface representing ApplicationLogsConfig. Application logs configuration.

Optional azureBlobStorage

azureBlobStorage: AzureBlobStorageApplicationLogsConfig

member: {AzureBlobStorageApplicationLogsConfig} [azureBlobStorage] Application logs to blob storage configuration.

Optional azureTableStorage

azureTableStorage: AzureTableStorageApplicationLogsConfig

member: {AzureTableStorageApplicationLogsConfig} [azureTableStorage] Application logs to azure table storage configuration.

Optional fileSystem

fileSystem: FileSystemApplicationLogsConfig

member: {FileSystemApplicationLogsConfig} [fileSystem] Application logs to file system configuration.

serializedName

serializedName: string = "ApplicationLogsConfig"

type

type: object

className

className: string = "ApplicationLogsConfig"

name

modelProperties

name

Const ApplicationStack

ApplicationStack: object

interface: An interface representing ApplicationStack. Application stack.

Optional dependency

dependency: undefined | string

member: {string} [dependency] Application stack dependency.

Optional display

display: undefined | string

member: {string} [display] Application stack display name.

Optional frameworks

frameworks: ApplicationStack[]

member: {ApplicationStack[]} [frameworks] List of frameworks associated with application stack.

Optional majorVersions

majorVersions: StackMajorVersion[]

member: {StackMajorVersion[]} [majorVersions] List of major versions available.

Optional name

member: {string} [name] Application stack name.

serializedName

serializedName: string = "ApplicationStack"

type

type: object

className

className: string = "ApplicationStack"

name

modelProperties

name

name

serializedName

serializedName: string = "name"

type

type: object

name

Const ApplicationStackCollection

ApplicationStackCollection: object

interface: An interface representing the ApplicationStackCollection. Collection of Application Stacks
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ApplicationStackCollection"

__@iterator

__@iterator(): IterableIterator<ApplicationStack>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<ApplicationStack>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<ApplicationStack>[]): ApplicationStack[]
concat(...items: (T | ConcatArray<T>)[]): ApplicationStack[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<ApplicationStack>[]
 
 Additional items to add to the end of array1.
Returns ApplicationStack[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns ApplicationStack[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, ApplicationStack]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, ApplicationStack]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: ApplicationStack, index: number, array: ApplicationStack[]): boolean
    - Parameters
      - value: ApplicationStack
      - index: number
      - array: ApplicationStack[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: ApplicationStack, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: ApplicationStack
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): ApplicationStack[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: ApplicationStack
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ApplicationStack, index: number, array: ApplicationStack[]): boolean
    - Parameters
      - value: ApplicationStack
      - index: number
      - array: ApplicationStack[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ApplicationStack, index: number, array: ApplicationStack[]): any
    - Parameters
      - value: ApplicationStack
      - index: number
      - array: ApplicationStack[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns ApplicationStack[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): ApplicationStack | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: ApplicationStack
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: ApplicationStack, index: number, obj: ApplicationStack[]): boolean
    - Parameters
      - this: void
      - value: ApplicationStack
      - index: number
      - obj: ApplicationStack[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: ApplicationStack, index: number, obj: ApplicationStack[]): boolean
    - Parameters
      - value: ApplicationStack
      - index: number
      - obj: ApplicationStack[]
      Returns boolean
- Optional thisArg: any
Returns ApplicationStack | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: ApplicationStack, index: number, obj: ApplicationStack[]): boolean
    - Parameters
      - value: ApplicationStack
      - index: number
      - obj: ApplicationStack[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: ApplicationStack, index: number, array: ApplicationStack[]): void
    - Parameters
      - value: ApplicationStack
      - index: number
      - array: ApplicationStack[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: ApplicationStack, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: ApplicationStack
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: ApplicationStack, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: ApplicationStack
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: ApplicationStack, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: ApplicationStack
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: ApplicationStack, index: number, array: ApplicationStack[]): U
    - Parameters
      - value: ApplicationStack
      - index: number
      - array: ApplicationStack[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): ApplicationStack | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns ApplicationStack | undefined

push

push(...items: ApplicationStack[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: ApplicationStack[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): ApplicationStack
reduce(callbackfn: function, initialValue: ApplicationStack): ApplicationStack
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ApplicationStack, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): ApplicationStack
    - Parameters
      - previousValue: ApplicationStack
      - currentValue: ApplicationStack
      - currentIndex: number
      - array: ApplicationStack[]
      Returns ApplicationStack
Returns ApplicationStack
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: ApplicationStack, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): ApplicationStack
    - Parameters
      - previousValue: ApplicationStack
      - currentValue: ApplicationStack
      - currentIndex: number
      - array: ApplicationStack[]
      Returns ApplicationStack
- initialValue: ApplicationStack
Returns ApplicationStack
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): U
    - Parameters
      - previousValue: U
      - currentValue: ApplicationStack
      - currentIndex: number
      - array: ApplicationStack[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): ApplicationStack
reduceRight(callbackfn: function, initialValue: ApplicationStack): ApplicationStack
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ApplicationStack, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): ApplicationStack
    - Parameters
      - previousValue: ApplicationStack
      - currentValue: ApplicationStack
      - currentIndex: number
      - array: ApplicationStack[]
      Returns ApplicationStack
Returns ApplicationStack
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: ApplicationStack, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): ApplicationStack
    - Parameters
      - previousValue: ApplicationStack
      - currentValue: ApplicationStack
      - currentIndex: number
      - array: ApplicationStack[]
      Returns ApplicationStack
- initialValue: ApplicationStack
Returns ApplicationStack
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ApplicationStack, currentIndex: number, array: ApplicationStack[]): U
    - Parameters
      - previousValue: U
      - currentValue: ApplicationStack
      - currentIndex: number
      - array: ApplicationStack[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): ApplicationStack[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns ApplicationStack[]

shift

shift(): ApplicationStack | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns ApplicationStack | undefined

slice

slice(start?: undefined | number, end?: undefined | number): ApplicationStack[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns ApplicationStack[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: ApplicationStack, index: number, array: ApplicationStack[]): boolean
    - Parameters
      - value: ApplicationStack
      - index: number
      - array: ApplicationStack[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): ApplicationStack[]
splice(start: number, deleteCount: number, ...items: ApplicationStack[]): ApplicationStack[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns ApplicationStack[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: ApplicationStack[]
  
  Elements to insert into the array in place of the deleted elements.
Returns ApplicationStack[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: ApplicationStack[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: ApplicationStack[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<ApplicationStack>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<ApplicationStack>

type

type: object

className

className: string = "ApplicationStackCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "ApplicationStack"

name

Const AutoHealActions

AutoHealActions: object

interface: An interface representing AutoHealActions. Actions which to take by the auto-heal module when a rule is triggered.

Optional actionType

actionType: AutoHealActionType

member: {AutoHealActionType} [actionType] Predefined action to be taken. Possible values include: 'Recycle', 'LogEvent', 'CustomAction'

Optional customAction

customAction: AutoHealCustomAction

member: {AutoHealCustomAction} [customAction] Custom action to be taken.

Optional minProcessExecutionTime

minProcessExecutionTime: undefined | string

member: {string} [minProcessExecutionTime] Minimum time the process must execute before taking the action

serializedName

serializedName: string = "AutoHealActions"

type

type: object

className

className: string = "AutoHealActions"

name

modelProperties

modelProperties: object

actionType

actionType: object

serializedName

serializedName: string = "actionType"

type

type: object

allowedValues

allowedValues: string[] = ["Recycle","LogEvent","CustomAction"]

name

customAction

customAction: object

serializedName

serializedName: string = "customAction"

type

type: object

className

className: string = "AutoHealCustomAction"

name

minProcessExecutionTime

minProcessExecutionTime: object

serializedName

serializedName: string = "minProcessExecutionTime"

type

type: object

name

Const AutoHealCustomAction

AutoHealCustomAction: object

interface: An interface representing AutoHealCustomAction. Custom action to be executed when an auto heal rule is triggered.

Optional exe

exe: undefined | string

member: {string} [exe] Executable to be run.

Optional parameters

parameters: undefined | string

member: {string} [parameters] Parameters for the executable.

serializedName

serializedName: string = "AutoHealCustomAction"

type

type: object

className

className: string = "AutoHealCustomAction"

name

modelProperties

modelProperties: object

exe

exe: object

serializedName

serializedName: string = "exe"

type

type: object

name

parameters

parameters: object

serializedName

serializedName: string = "parameters"

type

type: object

name

Const AutoHealRules

AutoHealRules: object

interface: An interface representing AutoHealRules. Rules that can be defined for auto-heal.

Optional actions

actions: AutoHealActions

member: {AutoHealActions} [actions] Actions to be executed when a rule is triggered.

serializedName

serializedName: string = "AutoHealRules"

Optional triggers

triggers: AutoHealTriggers

member: {AutoHealTriggers} [triggers] Conditions that describe when to execute the auto-heal actions.

type

type: object

className

className: string = "AutoHealRules"

name

modelProperties

modelProperties: object

actions

actions: object

serializedName

serializedName: string = "actions"

type

type: object

className

className: string = "AutoHealActions"

name

triggers

triggers: object

serializedName

serializedName: string = "triggers"

type

type: object

className

className: string = "AutoHealTriggers"

name

Const AutoHealTriggers

AutoHealTriggers: object

interface: An interface representing AutoHealTriggers. Triggers for auto-heal.

Optional privateBytesInKB

privateBytesInKB: undefined | number

member: {number} [privateBytesInKB] A rule based on private bytes.

Optional requests

requests: RequestsBasedTrigger

member: {RequestsBasedTrigger} [requests] A rule based on total requests.

serializedName

serializedName: string = "AutoHealTriggers"

Optional slowRequests

slowRequests: SlowRequestsBasedTrigger

member: {SlowRequestsBasedTrigger} [slowRequests] A rule based on request execution time.

Optional statusCodes

statusCodes: StatusCodesBasedTrigger[]

member: {StatusCodesBasedTrigger[]} [statusCodes] A rule based on status codes.

name

Const AzureBlobStorageApplicationLogsConfig

AzureBlobStorageApplicationLogsConfig: object

interface: An interface representing AzureBlobStorageApplicationLogsConfig. Application logs azure blob storage configuration.

Optional level

level: LogLevel

member: {LogLevel} [level] Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'

Optional retentionInDays

retentionInDays: undefined | number

member: {number} [retentionInDays] Retention in days. Remove blobs older than X days. 0 or lower means no retention.

Optional sasUrl

sasUrl: undefined | string

member: {string} [sasUrl] SAS url to a azure blob container with read/write/list/delete permissions.

serializedName

serializedName: string = "AzureBlobStorageApplicationLogsConfig"

type

type: object

className

className: string = "AzureBlobStorageApplicationLogsConfig"

name

modelProperties

modelProperties: object

level

name

Const AzureBlobStorageHttpLogsConfig

AzureBlobStorageHttpLogsConfig: object

interface: An interface representing AzureBlobStorageHttpLogsConfig. Http logs to azure blob storage configuration.

Optional enabled

enabled: undefined | false | true

member: {boolean} [enabled] True if configuration is enabled, false if it is disabled and null if configuration is not set.

Optional retentionInDays

retentionInDays: undefined | number

member: {number} [retentionInDays] Retention in days. Remove blobs older than X days. 0 or lower means no retention.

Optional sasUrl

sasUrl: undefined | string

member: {string} [sasUrl] SAS url to a azure blob container with read/write/list/delete permissions.

serializedName

serializedName: string = "AzureBlobStorageHttpLogsConfig"

type

type: object

className

className: string = "AzureBlobStorageHttpLogsConfig"

name

modelProperties

name

Const AzureStorageInfoValue

AzureStorageInfoValue: object

interface: An interface representing AzureStorageInfoValue. Azure Files or Blob Storage access information value for dictionary storage.

Optional accessKey

accessKey: undefined | string

member: {string} [accessKey] Access key for the storage account.

Optional accountName

accountName: undefined | string

member: {string} [accountName] Name of the storage account.

Optional mountPath

mountPath: undefined | string

member: {string} [mountPath] Path to mount the storage within the site's runtime environment.

serializedName

serializedName: string = "AzureStorageInfoValue"

Optional shareName

shareName: undefined | string

member: {string} [shareName] Name of the file share (container name, for Blob storage).

Optional state

state: AzureStorageState

member: {AzureStorageState} [state] State of the storage account. Possible values include: 'Ok', 'InvalidCredentials', 'InvalidShare' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

member: {AzureStorageType} [type] Type of storage. Possible values include: 'AzureFiles', 'AzureBlob'

className

className: string = "AzureStorageInfoValue"

name

modelProperties

type

type: object

allowedValues

allowedValues: string[] = ["Ok","InvalidCredentials","InvalidShare"]

name

type

type: object

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["AzureFiles","AzureBlob"]

name

Const AzureStoragePropertyDictionaryResource

AzureStoragePropertyDictionaryResource: object

interface: An interface representing AzureStoragePropertyDictionaryResource. AzureStorageInfo dictionary resource.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | object

member: {{ [propertyName: string]: AzureStorageInfoValue }} [properties] Azure storage accounts.

serializedName

serializedName: string = "AzureStoragePropertyDictionaryResource"

type

type: object

className

className: string = "AzureStoragePropertyDictionaryResource"

name

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

value

value: object

type

type: object

className

className: string = "AzureStorageInfoValue"

name

Const AzureTableStorageApplicationLogsConfig

AzureTableStorageApplicationLogsConfig: object

interface: An interface representing AzureTableStorageApplicationLogsConfig. Application logs to Azure table storage configuration.

Optional level

level: LogLevel

member: {LogLevel} [level] Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'

sasUrl

sasUrl: string

member: {string} sasUrl SAS URL to an Azure table with add/query/delete permissions.

serializedName

serializedName: string = "AzureTableStorageApplicationLogsConfig"

type

type: object

className

className: string = "AzureTableStorageApplicationLogsConfig"

name

modelProperties

modelProperties: object

level

level: object

serializedName

serializedName: string = "level"

type

type: object

allowedValues

allowedValues: string[] = ["Off","Verbose","Information","Warning","Error"]

name

sasUrl

sasUrl: object

required

required: true = true

serializedName

serializedName: string = "sasUrl"

type

type: object

name

Const BackupItem

BackupItem: object

interface: An interface representing BackupItem. Backup description.
extends: ProxyOnlyResource

Optional backupId

backupId: undefined | number

member: {number} [backupId] Id of the backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional backupItemName

backupItemName: undefined | string

member: {string} [backupItemName] Name of this backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional blobName

blobName: undefined | string

member: {string} [blobName] Name of the blob which contains data for this backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional correlationId

correlationId: undefined | string

member: {string} [correlationId] Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. NOTE: This property will not be serialized. It can only be populated by the server.

Optional created

created: Date

member: {Date} [created] Timestamp of the backup creation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional databases

databases: DatabaseBackupSetting[]

member: {DatabaseBackupSetting[]} [databases] List of databases included in the backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional finishedTimeStamp

finishedTimeStamp: Date

member: {Date} [finishedTimeStamp] Timestamp when this backup finished. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional lastRestoreTimeStamp

lastRestoreTimeStamp: Date

member: {Date} [lastRestoreTimeStamp] Timestamp of a last restore operation which used this backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional log

log: undefined | string

member: {string} [log] Details regarding this backup. Might contain an error message. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scheduled

scheduled: undefined | false | true

member: {boolean} [scheduled] True if this backup has been created due to a schedule being triggered. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BackupItem"

Optional sizeInBytes

sizeInBytes: undefined | number

member: {number} [sizeInBytes] Size of the backup in bytes. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

status: BackupItemStatus

member: {BackupItemStatus} [status] Backup status. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created', 'Skipped', 'PartiallySucceeded', 'DeleteInProgress', 'DeleteFailed', 'Deleted' NOTE: This property will not be serialized. It can only be populated by the server.

Optional storageAccountUrl

storageAccountUrl: undefined | string

member: {string} [storageAccountUrl] SAS URL for the storage account container which contains this backup. NOTE: This property will not be serialized. It can only be populated by the server.

Optional websiteSizeInBytes

websiteSizeInBytes: undefined | number

member: {number} [websiteSizeInBytes] Size of the original web app which has been backed up. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "BackupItem"

name

modelProperties

name

Const BackupItemCollection

BackupItemCollection: object

interface: An interface representing the BackupItemCollection. Collection of backup items.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BackupItemCollection"

__@iterator

__@iterator(): IterableIterator<BackupItem>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<BackupItem>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<BackupItem>[]): BackupItem[]
concat(...items: (T | ConcatArray<T>)[]): BackupItem[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<BackupItem>[]
 
 Additional items to add to the end of array1.
Returns BackupItem[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns BackupItem[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, BackupItem]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, BackupItem]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: BackupItem, index: number, array: BackupItem[]): boolean
    - Parameters
      - value: BackupItem
      - index: number
      - array: BackupItem[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: BackupItem, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: BackupItem
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): BackupItem[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: BackupItem
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: BackupItem, index: number, array: BackupItem[]): boolean
    - Parameters
      - value: BackupItem
      - index: number
      - array: BackupItem[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: BackupItem, index: number, array: BackupItem[]): any
    - Parameters
      - value: BackupItem
      - index: number
      - array: BackupItem[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns BackupItem[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): BackupItem | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: BackupItem
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: BackupItem, index: number, obj: BackupItem[]): boolean
    - Parameters
      - this: void
      - value: BackupItem
      - index: number
      - obj: BackupItem[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: BackupItem, index: number, obj: BackupItem[]): boolean
    - Parameters
      - value: BackupItem
      - index: number
      - obj: BackupItem[]
      Returns boolean
- Optional thisArg: any
Returns BackupItem | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: BackupItem, index: number, obj: BackupItem[]): boolean
    - Parameters
      - value: BackupItem
      - index: number
      - obj: BackupItem[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: BackupItem, index: number, array: BackupItem[]): void
    - Parameters
      - value: BackupItem
      - index: number
      - array: BackupItem[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: BackupItem, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: BackupItem
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: BackupItem, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: BackupItem
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: BackupItem, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: BackupItem
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: BackupItem, index: number, array: BackupItem[]): U
    - Parameters
      - value: BackupItem
      - index: number
      - array: BackupItem[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): BackupItem | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns BackupItem | undefined

push

push(...items: BackupItem[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: BackupItem[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): BackupItem
reduce(callbackfn: function, initialValue: BackupItem): BackupItem
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: BackupItem, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): BackupItem
    - Parameters
      - previousValue: BackupItem
      - currentValue: BackupItem
      - currentIndex: number
      - array: BackupItem[]
      Returns BackupItem
Returns BackupItem
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: BackupItem, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): BackupItem
    - Parameters
      - previousValue: BackupItem
      - currentValue: BackupItem
      - currentIndex: number
      - array: BackupItem[]
      Returns BackupItem
- initialValue: BackupItem
Returns BackupItem
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): U
    - Parameters
      - previousValue: U
      - currentValue: BackupItem
      - currentIndex: number
      - array: BackupItem[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): BackupItem
reduceRight(callbackfn: function, initialValue: BackupItem): BackupItem
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: BackupItem, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): BackupItem
    - Parameters
      - previousValue: BackupItem
      - currentValue: BackupItem
      - currentIndex: number
      - array: BackupItem[]
      Returns BackupItem
Returns BackupItem
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: BackupItem, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): BackupItem
    - Parameters
      - previousValue: BackupItem
      - currentValue: BackupItem
      - currentIndex: number
      - array: BackupItem[]
      Returns BackupItem
- initialValue: BackupItem
Returns BackupItem
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: BackupItem, currentIndex: number, array: BackupItem[]): U
    - Parameters
      - previousValue: U
      - currentValue: BackupItem
      - currentIndex: number
      - array: BackupItem[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): BackupItem[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns BackupItem[]

shift

shift(): BackupItem | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns BackupItem | undefined

slice

slice(start?: undefined | number, end?: undefined | number): BackupItem[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns BackupItem[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: BackupItem, index: number, array: BackupItem[]): boolean
    - Parameters
      - value: BackupItem
      - index: number
      - array: BackupItem[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): BackupItem[]
splice(start: number, deleteCount: number, ...items: BackupItem[]): BackupItem[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns BackupItem[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: BackupItem[]
  
  Elements to insert into the array in place of the deleted elements.
Returns BackupItem[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: BackupItem[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: BackupItem[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<BackupItem>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<BackupItem>

type

type: object

className

className: string = "BackupItemCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "BackupItem"

name

Const BackupRequest

BackupRequest: object

interface: An interface representing BackupRequest. Description of a backup which will be performed.
extends: ProxyOnlyResource

Optional backupName

backupName: undefined | string

member: {string} [backupName] Name of the backup.

Optional backupSchedule

backupSchedule: BackupSchedule

member: {BackupSchedule} [backupSchedule] Schedule for the backup if it is executed periodically.

Optional databases

databases: DatabaseBackupSetting[]

member: {DatabaseBackupSetting[]} [databases] Databases included in the backup.

Optional enabled

enabled: undefined | false | true

member: {boolean} [enabled] True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BackupRequest"

storageAccountUrl

storageAccountUrl: string

member: {string} storageAccountUrl SAS URL to the container.

type

type: object

className

className: string = "BackupRequest"

name

modelProperties

modelProperties: object

backupName

backupName: object

serializedName

serializedName: string = "properties.backupName"

type

type: object

name

backupSchedule

type

type: object

name

Const BackupSchedule

BackupSchedule: object

interface: An interface representing BackupSchedule. Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.

frequencyInterval

frequencyInterval: number

member: {number} frequencyInterval How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day). Default value: 7 .

frequencyUnit

frequencyUnit: FrequencyUnit

member: {FrequencyUnit} frequencyUnit The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7). Possible values include: 'Day', 'Hour'. Default value: 'Day' .

keepAtLeastOneBackup

keepAtLeastOneBackup: boolean

member: {boolean} keepAtLeastOneBackup True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. Default value: true .

Optional lastExecutionTime

lastExecutionTime: Date

member: {Date} [lastExecutionTime] Last time when this schedule was triggered. NOTE: This property will not be serialized. It can only be populated by the server.

retentionPeriodInDays

retentionPeriodInDays: number

member: {number} retentionPeriodInDays After how many days backups should be deleted. Default value: 30 .

serializedName

serializedName: string = "BackupSchedule"

Optional startTime

startTime: Date

member: {Date} [startTime] When the schedule should start working.

type

type: object

name

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

Const BillingMeter

BillingMeter: object

interface: An interface representing BillingMeter. App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services.
extends: ProxyOnlyResource

Optional billingLocation

billingLocation: undefined | string

member: {string} [billingLocation] Azure Location of billable resource

Optional friendlyName

friendlyName: undefined | string

member: {string} [friendlyName] Friendly name of the meter

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional meterId

meterId: undefined | string

member: {string} [meterId] Meter GUID onboarded in Commerce

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional osType

osType: undefined | string

member: {string} [osType] App Service OS type meter used for

Optional resourceType

resourceType: undefined | string

member: {string} [resourceType] App Service ResourceType meter used for

serializedName

serializedName: string = "BillingMeter"

Optional shortName

shortName: undefined | string

member: {string} [shortName] Short Name from App Service Azure pricing Page

type

type: object

className

className: string = "BillingMeter"

name

modelProperties

name

Const BillingMeterCollection

BillingMeterCollection: object

interface: An interface representing the BillingMeterCollection. Collection of Billing Meters
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "BillingMeterCollection"

__@iterator

__@iterator(): IterableIterator<BillingMeter>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<BillingMeter>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<BillingMeter>[]): BillingMeter[]
concat(...items: (T | ConcatArray<T>)[]): BillingMeter[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<BillingMeter>[]
 
 Additional items to add to the end of array1.
Returns BillingMeter[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns BillingMeter[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, BillingMeter]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, BillingMeter]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: BillingMeter, index: number, array: BillingMeter[]): boolean
    - Parameters
      - value: BillingMeter
      - index: number
      - array: BillingMeter[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: BillingMeter, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: BillingMeter
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): BillingMeter[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: BillingMeter
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: BillingMeter, index: number, array: BillingMeter[]): boolean
    - Parameters
      - value: BillingMeter
      - index: number
      - array: BillingMeter[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: BillingMeter, index: number, array: BillingMeter[]): any
    - Parameters
      - value: BillingMeter
      - index: number
      - array: BillingMeter[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns BillingMeter[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): BillingMeter | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: BillingMeter
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: BillingMeter, index: number, obj: BillingMeter[]): boolean
    - Parameters
      - this: void
      - value: BillingMeter
      - index: number
      - obj: BillingMeter[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: BillingMeter, index: number, obj: BillingMeter[]): boolean
    - Parameters
      - value: BillingMeter
      - index: number
      - obj: BillingMeter[]
      Returns boolean
- Optional thisArg: any
Returns BillingMeter | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: BillingMeter, index: number, obj: BillingMeter[]): boolean
    - Parameters
      - value: BillingMeter
      - index: number
      - obj: BillingMeter[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: BillingMeter, index: number, array: BillingMeter[]): void
    - Parameters
      - value: BillingMeter
      - index: number
      - array: BillingMeter[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: BillingMeter, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: BillingMeter
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: BillingMeter, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: BillingMeter
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: BillingMeter, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: BillingMeter
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: BillingMeter, index: number, array: BillingMeter[]): U
    - Parameters
      - value: BillingMeter
      - index: number
      - array: BillingMeter[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): BillingMeter | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns BillingMeter | undefined

push

push(...items: BillingMeter[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: BillingMeter[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): BillingMeter
reduce(callbackfn: function, initialValue: BillingMeter): BillingMeter
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: BillingMeter, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): BillingMeter
    - Parameters
      - previousValue: BillingMeter
      - currentValue: BillingMeter
      - currentIndex: number
      - array: BillingMeter[]
      Returns BillingMeter
Returns BillingMeter
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: BillingMeter, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): BillingMeter
    - Parameters
      - previousValue: BillingMeter
      - currentValue: BillingMeter
      - currentIndex: number
      - array: BillingMeter[]
      Returns BillingMeter
- initialValue: BillingMeter
Returns BillingMeter
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): U
    - Parameters
      - previousValue: U
      - currentValue: BillingMeter
      - currentIndex: number
      - array: BillingMeter[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): BillingMeter
reduceRight(callbackfn: function, initialValue: BillingMeter): BillingMeter
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: BillingMeter, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): BillingMeter
    - Parameters
      - previousValue: BillingMeter
      - currentValue: BillingMeter
      - currentIndex: number
      - array: BillingMeter[]
      Returns BillingMeter
Returns BillingMeter
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: BillingMeter, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): BillingMeter
    - Parameters
      - previousValue: BillingMeter
      - currentValue: BillingMeter
      - currentIndex: number
      - array: BillingMeter[]
      Returns BillingMeter
- initialValue: BillingMeter
Returns BillingMeter
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: BillingMeter, currentIndex: number, array: BillingMeter[]): U
    - Parameters
      - previousValue: U
      - currentValue: BillingMeter
      - currentIndex: number
      - array: BillingMeter[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): BillingMeter[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns BillingMeter[]

shift

shift(): BillingMeter | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns BillingMeter | undefined

slice

slice(start?: undefined | number, end?: undefined | number): BillingMeter[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns BillingMeter[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: BillingMeter, index: number, array: BillingMeter[]): boolean
    - Parameters
      - value: BillingMeter
      - index: number
      - array: BillingMeter[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): BillingMeter[]
splice(start: number, deleteCount: number, ...items: BillingMeter[]): BillingMeter[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns BillingMeter[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: BillingMeter[]
  
  Elements to insert into the array in place of the deleted elements.
Returns BillingMeter[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: BillingMeter[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: BillingMeter[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<BillingMeter>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<BillingMeter>

type

type: object

className

className: string = "BillingMeterCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "BillingMeter"

name

Const Capability

Capability: object

interface: An interface representing Capability. Describes the capabilities/features allowed for a specific SKU.

Optional name

member: {string} [name] Name of the SKU capability.

Optional reason

reason: undefined | string

member: {string} [reason] Reason of the SKU capability.

serializedName

serializedName: string = "Capability"

Optional value

value: undefined | string

member: {string} [value] Value of the SKU capability.

type

type: object

className

className: string = "Capability"

name

modelProperties

modelProperties: object

Certificate: object

interface: An interface representing Certificate. SSL certificate for an app.
extends: Resource

Optional cerBlob

cerBlob: Uint8Array

member: {Uint8Array} [cerBlob] Raw bytes of .cer file NOTE: This property will not be serialized. It can only be populated by the server.

Optional expirationDate

expirationDate: Date

member: {Date} [expirationDate] Certificate expriration date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional friendlyName

friendlyName: undefined | string

member: {string} [friendlyName] Friendly name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostNames

hostNames: string[]

member: {string[]} [hostNames] Host names the certificate applies to.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

member: {HostingEnvironmentProfile} [hostingEnvironmentProfile] Specification for the App Service Environment to use for the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issueDate

issueDate: Date

member: {Date} [issueDate] Certificate issue Date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issuer

issuer: undefined | string

member: {string} [issuer] Certificate issuer. NOTE: This property will not be serialized. It can only be populated by the server.

Optional keyVaultId

keyVaultId: undefined | string

member: {string} [keyVaultId] Key Vault Csm resource Id.

Optional keyVaultSecretName

keyVaultSecretName: undefined | string

member: {string} [keyVaultSecretName] Key Vault secret name.

Optional keyVaultSecretStatus

keyVaultSecretStatus: KeyVaultSecretStatus

member: {KeyVaultSecretStatus} [keyVaultSecretStatus] Status of the Key Vault secret. Possible values include: 'Initialized', 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

location

location: string

member: {string} location Resource Location.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

password

password: string

member: {string} password Certificate password.

Optional pfxBlob

pfxBlob: Uint8Array

member: {Uint8Array} [pfxBlob] Pfx blob.

Optional publicKeyHash

publicKeyHash: undefined | string

member: {string} [publicKeyHash] Public key hash. NOTE: This property will not be serialized. It can only be populated by the server.

Optional selfLink

selfLink: undefined | string

member: {string} [selfLink] Self link. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Certificate"

Optional serverFarmId

serverFarmId: undefined | string

member: {string} [serverFarmId] Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

Optional siteName

siteName: undefined | string

member: {string} [siteName] App name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional subjectName

subjectName: undefined | string

member: {string} [subjectName] Subject name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

member: {{ [propertyName: string]: string }} [tags] Resource tags.

Optional thumbprint

thumbprint: undefined | string

member: {string} [thumbprint] Certificate thumbprint. NOTE: This property will not be serialized. It can only be populated by the server.

Optional valid

valid: undefined | false | true

member: {boolean} [valid] Is the certificate valid?. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "Certificate"

name

modelProperties

className

className: string = "HostingEnvironmentProfile"

name

issueDate

issueDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.issueDate"

type

type: object

name

issuer

type

type: object

allowedValues

name

password

type

type: object

name

selfLink

selfLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.selfLink"

type

type: object

CertificateCollection: object

interface: An interface representing the CertificateCollection. Collection of certificates.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CertificateCollection"

__@iterator

__@iterator(): IterableIterator<Certificate>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<Certificate>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<Certificate>[]): Certificate[]
concat(...items: (T | ConcatArray<T>)[]): Certificate[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<Certificate>[]
 
 Additional items to add to the end of array1.
Returns Certificate[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns Certificate[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, Certificate]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, Certificate]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: Certificate, index: number, array: Certificate[]): boolean
    - Parameters
      - value: Certificate
      - index: number
      - array: Certificate[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: Certificate, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: Certificate
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): Certificate[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: Certificate
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Certificate, index: number, array: Certificate[]): boolean
    - Parameters
      - value: Certificate
      - index: number
      - array: Certificate[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Certificate, index: number, array: Certificate[]): any
    - Parameters
      - value: Certificate
      - index: number
      - array: Certificate[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Certificate[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): Certificate | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: Certificate
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: Certificate, index: number, obj: Certificate[]): boolean
    - Parameters
      - this: void
      - value: Certificate
      - index: number
      - obj: Certificate[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: Certificate, index: number, obj: Certificate[]): boolean
    - Parameters
      - value: Certificate
      - index: number
      - obj: Certificate[]
      Returns boolean
- Optional thisArg: any
Returns Certificate | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: Certificate, index: number, obj: Certificate[]): boolean
    - Parameters
      - value: Certificate
      - index: number
      - obj: Certificate[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: Certificate, index: number, array: Certificate[]): void
    - Parameters
      - value: Certificate
      - index: number
      - array: Certificate[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: Certificate, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: Certificate
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: Certificate, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: Certificate
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: Certificate, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: Certificate
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: Certificate, index: number, array: Certificate[]): U
    - Parameters
      - value: Certificate
      - index: number
      - array: Certificate[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): Certificate | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns Certificate | undefined

push

push(...items: Certificate[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: Certificate[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): Certificate
reduce(callbackfn: function, initialValue: Certificate): Certificate
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Certificate, currentValue: Certificate, currentIndex: number, array: Certificate[]): Certificate
    - Parameters
      - previousValue: Certificate
      - currentValue: Certificate
      - currentIndex: number
      - array: Certificate[]
      Returns Certificate
Returns Certificate
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: Certificate, currentValue: Certificate, currentIndex: number, array: Certificate[]): Certificate
    - Parameters
      - previousValue: Certificate
      - currentValue: Certificate
      - currentIndex: number
      - array: Certificate[]
      Returns Certificate
- initialValue: Certificate
Returns Certificate
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Certificate, currentIndex: number, array: Certificate[]): U
    - Parameters
      - previousValue: U
      - currentValue: Certificate
      - currentIndex: number
      - array: Certificate[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): Certificate
reduceRight(callbackfn: function, initialValue: Certificate): Certificate
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Certificate, currentValue: Certificate, currentIndex: number, array: Certificate[]): Certificate
    - Parameters
      - previousValue: Certificate
      - currentValue: Certificate
      - currentIndex: number
      - array: Certificate[]
      Returns Certificate
Returns Certificate
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: Certificate, currentValue: Certificate, currentIndex: number, array: Certificate[]): Certificate
    - Parameters
      - previousValue: Certificate
      - currentValue: Certificate
      - currentIndex: number
      - array: Certificate[]
      Returns Certificate
- initialValue: Certificate
Returns Certificate
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Certificate, currentIndex: number, array: Certificate[]): U
    - Parameters
      - previousValue: U
      - currentValue: Certificate
      - currentIndex: number
      - array: Certificate[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): Certificate[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns Certificate[]

shift

shift(): Certificate | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns Certificate | undefined

slice

slice(start?: undefined | number, end?: undefined | number): Certificate[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns Certificate[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: Certificate, index: number, array: Certificate[]): boolean
    - Parameters
      - value: Certificate
      - index: number
      - array: Certificate[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): Certificate[]
splice(start: number, deleteCount: number, ...items: Certificate[]): Certificate[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns Certificate[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: Certificate[]
  
  Elements to insert into the array in place of the deleted elements.
Returns Certificate[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: Certificate[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: Certificate[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<Certificate>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<Certificate>

type

type: object

className

className: string = "CertificateCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "Certificate"

name

Const CertificateDetails

CertificateDetails: object

interface: An interface representing CertificateDetails. SSL certificate details.

Optional issuer

issuer: undefined | string

member: {string} [issuer] Certificate Issuer. NOTE: This property will not be serialized. It can only be populated by the server.

Optional notAfter

notAfter: Date

member: {Date} [notAfter] Date Certificate is valid to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional notBefore

notBefore: Date

member: {Date} [notBefore] Date Certificate is valid from. NOTE: This property will not be serialized. It can only be populated by the server.

Optional rawData

rawData: undefined | string

member: {string} [rawData] Raw certificate data. NOTE: This property will not be serialized. It can only be populated by the server.

Optional serialNumber

serialNumber: undefined | string

member: {string} [serialNumber] Certificate Serial Number. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CertificateDetails"

Optional signatureAlgorithm

signatureAlgorithm: undefined | string

member: {string} [signatureAlgorithm] Certificate Signature algorithm. NOTE: This property will not be serialized. It can only be populated by the server.

Optional subject

subject: undefined | string

member: {string} [subject] Certificate Subject. NOTE: This property will not be serialized. It can only be populated by the server.

Optional thumbprint

thumbprint: undefined | string

member: {string} [thumbprint] Certificate Thumbprint. NOTE: This property will not be serialized. It can only be populated by the server.

Optional version

version: undefined | number

member: {number} [version] Certificate Version. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "CertificateDetails"

name

modelProperties

name

Const CertificateEmail

CertificateEmail: object

interface: An interface representing CertificateEmail. SSL certificate email.
extends: ProxyOnlyResource

Optional emailId

emailId: undefined | string

member: {string} [emailId] Email id.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CertificateEmail"

Optional timeStamp

timeStamp: Date

member: {Date} [timeStamp] Time stamp.

type

type: object

className

className: string = "CertificateEmail"

name

modelProperties

modelProperties: object

emailId

emailId: object

serializedName

serializedName: string = "properties.emailId"

type

type: object

name

timeStamp

timeStamp: object

serializedName

serializedName: string = "properties.timeStamp"

type

type: object

name

Const CertificateOrderAction

CertificateOrderAction: object

interface: An interface representing CertificateOrderAction. Certificate order action.
extends: ProxyOnlyResource

Optional actionType

actionType: CertificateOrderActionType

member: {CertificateOrderActionType} [actionType] Action type. Possible values include: 'CertificateIssued', 'CertificateOrderCanceled', 'CertificateOrderCreated', 'CertificateRevoked', 'DomainValidationComplete', 'FraudDetected', 'OrgNameChange', 'OrgValidationComplete', 'SanDrop', 'FraudCleared', 'CertificateExpired', 'CertificateExpirationWarning', 'FraudDocumentationRequired', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdAt

createdAt: Date

member: {Date} [createdAt] Time at which the certificate action was performed. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CertificateOrderAction"

type

type: object

className

className: string = "CertificateOrderAction"

name

modelProperties

modelProperties: object

actionType

actionType: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.actionType"

type

type: object

allowedValues

allowedValues: string[] = ["CertificateIssued","CertificateOrderCanceled","CertificateOrderCreated","CertificateRevoked","DomainValidationComplete","FraudDetected","OrgNameChange","OrgValidationComplete","SanDrop","FraudCleared","CertificateExpired","CertificateExpirationWarning","FraudDocumentationRequired","Unknown"]

name

createdAt

createdAt: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdAt"

type

type: object

name

Const CertificatePatchResource

CertificatePatchResource: object

interface: An interface representing CertificatePatchResource. ARM resource for a certificate.
extends: ProxyOnlyResource

Optional cerBlob

cerBlob: Uint8Array

member: {Uint8Array} [cerBlob] Raw bytes of .cer file NOTE: This property will not be serialized. It can only be populated by the server.

Optional expirationDate

expirationDate: Date

member: {Date} [expirationDate] Certificate expriration date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional friendlyName

friendlyName: undefined | string

member: {string} [friendlyName] Friendly name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostNames

hostNames: string[]

member: {string[]} [hostNames] Host names the certificate applies to.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

member: {HostingEnvironmentProfile} [hostingEnvironmentProfile] Specification for the App Service Environment to use for the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issueDate

issueDate: Date

member: {Date} [issueDate] Certificate issue Date. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issuer

issuer: undefined | string

member: {string} [issuer] Certificate issuer. NOTE: This property will not be serialized. It can only be populated by the server.

Optional keyVaultId

keyVaultId: undefined | string

member: {string} [keyVaultId] Key Vault Csm resource Id.

Optional keyVaultSecretName

keyVaultSecretName: undefined | string

member: {string} [keyVaultSecretName] Key Vault secret name.

Optional keyVaultSecretStatus

keyVaultSecretStatus: KeyVaultSecretStatus

member: {KeyVaultSecretStatus} [keyVaultSecretStatus] Status of the Key Vault secret. Possible values include: 'Initialized', 'WaitingOnCertificateOrder', 'Succeeded', 'CertificateOrderFailed', 'OperationNotPermittedOnKeyVault', 'AzureServiceUnauthorizedToAccessKeyVault', 'KeyVaultDoesNotExist', 'KeyVaultSecretDoesNotExist', 'UnknownError', 'ExternalPrivateKey', 'Unknown' NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

password

password: string

member: {string} password Certificate password.

Optional pfxBlob

pfxBlob: Uint8Array

member: {Uint8Array} [pfxBlob] Pfx blob.

Optional publicKeyHash

publicKeyHash: undefined | string

member: {string} [publicKeyHash] Public key hash. NOTE: This property will not be serialized. It can only be populated by the server.

Optional selfLink

selfLink: undefined | string

member: {string} [selfLink] Self link. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CertificatePatchResource"

Optional serverFarmId

serverFarmId: undefined | string

member: {string} [serverFarmId] Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

Optional siteName

siteName: undefined | string

member: {string} [siteName] App name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional subjectName

subjectName: undefined | string

member: {string} [subjectName] Subject name of the certificate. NOTE: This property will not be serialized. It can only be populated by the server.

Optional thumbprint

thumbprint: undefined | string

member: {string} [thumbprint] Certificate thumbprint. NOTE: This property will not be serialized. It can only be populated by the server.

Optional valid

valid: undefined | false | true

member: {boolean} [valid] Is the certificate valid?. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "CertificatePatchResource"

name

modelProperties

className

className: string = "HostingEnvironmentProfile"

name

issueDate

issueDate: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.issueDate"

type

type: object

name

issuer

type

type: object

allowedValues

name

password

type

type: object

name

selfLink

selfLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.selfLink"

type

type: object

CloningInfo: object

interface: An interface representing CloningInfo. Information needed for cloning operation.

Optional appSettingsOverrides

appSettingsOverrides: undefined | object

member: {{ [propertyName: string]: string }} [appSettingsOverrides] Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.

Optional cloneCustomHostNames

cloneCustomHostNames: undefined | false | true

member: {boolean} [cloneCustomHostNames] true to clone custom hostnames from source app; otherwise, false.

Optional cloneSourceControl

cloneSourceControl: undefined | false | true

member: {boolean} [cloneSourceControl] true to clone source control from source app; otherwise, false.

Optional configureLoadBalancing

configureLoadBalancing: undefined | false | true

member: {boolean} [configureLoadBalancing] true to configure load balancing for source and destination app.

Optional correlationId

correlationId: undefined | string

member: {string} [correlationId] Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.

Optional hostingEnvironment

hostingEnvironment: undefined | string

member: {string} [hostingEnvironment] App Service Environment.

Optional overwrite

overwrite: undefined | false | true

member: {boolean} [overwrite] true to overwrite destination app; otherwise, false.

serializedName

serializedName: string = "CloningInfo"

sourceWebAppId

sourceWebAppId: string

member: {string} sourceWebAppId ARM resource ID of the source app. App resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.

Optional trafficManagerProfileId

trafficManagerProfileId: undefined | string

member: {string} [trafficManagerProfileId] ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.

Optional trafficManagerProfileName

trafficManagerProfileName: undefined | string

member: {string} [trafficManagerProfileName] Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.

type

type: object

className

className: string = "CloningInfo"

name

modelProperties

modelProperties: object

appSettingsOverrides

appSettingsOverrides: object

serializedName

serializedName: string = "appSettingsOverrides"

type

type: object

name

Const ConnStringInfo

ConnStringInfo: object

interface: An interface representing ConnStringInfo. Database connection string information.

Optional connectionString

connectionString: undefined | string

member: {string} [connectionString] Connection string value.

Optional name

member: {string} [name] Name of connection string.

serializedName

serializedName: string = "ConnStringInfo"

type

type: object

member: {ConnectionStringType} [type] Type of database. Possible values include: 'MySql', 'SQLServer', 'SQLAzure', 'Custom', 'NotificationHub', 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'

className

className: string = "ConnStringInfo"

name

modelProperties

modelProperties: object

connectionString

connectionString: object

serializedName

serializedName: string = "connectionString"

type

type: object

name

name

serializedName

serializedName: string = "name"

type

type: object

name

type

type: object

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["MySql","SQLServer","SQLAzure","Custom","NotificationHub","ServiceBus","EventHub","ApiHub","DocDb","RedisCache","PostgreSQL"]

name

Const ConnStringValueTypePair

ConnStringValueTypePair: object

interface: An interface representing ConnStringValueTypePair. Database connection string value to type pair.

serializedName

serializedName: string = "ConnStringValueTypePair"

value

value: string

member: {string} value Value of pair.

type

type: object

member: {ConnectionStringType} type Type of database. Possible values include: 'MySql', 'SQLServer', 'SQLAzure', 'Custom', 'NotificationHub', 'ServiceBus', 'EventHub', 'ApiHub', 'DocDb', 'RedisCache', 'PostgreSQL'

className

className: string = "ConnStringValueTypePair"

name

modelProperties

modelProperties: object

type

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["MySql","SQLServer","SQLAzure","Custom","NotificationHub","ServiceBus","EventHub","ApiHub","DocDb","RedisCache","PostgreSQL"]

name

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

Const ConnectionStringDictionary

ConnectionStringDictionary: object

interface: An interface representing ConnectionStringDictionary. String dictionary resource.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | object

member: {{ [propertyName: string]: ConnStringValueTypePair }} [properties] Connection strings.

serializedName

serializedName: string = "ConnectionStringDictionary"

type

type: object

className

className: string = "ConnectionStringDictionary"

name

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

value

value: object

type

type: object

className

className: string = "ConnStringValueTypePair"

name

Const Contact

Contact: object

interface: An interface representing Contact. Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois directories as per ICANN requirements.

Optional addressMailing

addressMailing: Address

member: {Address} [addressMailing] Mailing address.

email

email: string

member: {string} email Email address.

Optional fax

fax: undefined | string

member: {string} [fax] Fax number.

Optional jobTitle

jobTitle: undefined | string

member: {string} [jobTitle] Job title.

nameFirst

nameFirst: string

member: {string} nameFirst First name.

nameLast

nameLast: string

member: {string} nameLast Last name.

Optional nameMiddle

nameMiddle: undefined | string

member: {string} [nameMiddle] Middle name.

Optional organization

organization: undefined | string

member: {string} [organization] Organization contact belongs to.

phone

phone: string

member: {string} phone Phone number.

serializedName

serializedName: string = "Contact"

type

type: object

className

className: string = "Contact"

name

modelProperties

modelProperties: object

addressMailing

addressMailing: object

serializedName

serializedName: string = "addressMailing"

type

type: object

className

className: string = "Address"

name

email

type

type: object

name

nameLast

type

type: object

name

Const ContinuousWebJob

ContinuousWebJob: object

interface: An interface representing ContinuousWebJob. Continuous Web Job Information.
extends: ProxyOnlyResource

Optional detailedStatus

detailedStatus: undefined | string

member: {string} [detailedStatus] Detailed status.

Optional error

error: undefined | string

member: {string} [error] Error information.

Optional extraInfoUrl

extraInfoUrl: undefined | string

member: {string} [extraInfoUrl] Extra Info URL.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional logUrl

logUrl: undefined | string

member: {string} [logUrl] Log URL.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runCommand

runCommand: undefined | string

member: {string} [runCommand] Run command.

serializedName

serializedName: string = "ContinuousWebJob"

Optional settings

settings: undefined | object

member: {{ [propertyName: string]: any }} [settings] Job settings.

Optional status

status: ContinuousWebJobStatus

member: {ContinuousWebJobStatus} [status] Job status. Possible values include: 'Initializing', 'Starting', 'Running', 'PendingRestart', 'Stopped'

Optional url

url: undefined | string

member: {string} [url] Job URL.

Optional usingSdk

usingSdk: undefined | false | true

member: {boolean} [usingSdk] Using SDK?

Optional webJobType

webJobType: WebJobType

member: {WebJobType} [webJobType] Job type. Possible values include: 'Continuous', 'Triggered'

type

type: object

className

className: string = "ContinuousWebJob"

name

modelProperties

allowedValues

allowedValues: string[] = ["Continuous","Triggered"]

name

Const ContinuousWebJobCollection

ContinuousWebJobCollection: object

interface: An interface representing the ContinuousWebJobCollection. Collection of Kudu continuous web job information elements.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ContinuousWebJobCollection"

__@iterator

__@iterator(): IterableIterator<ContinuousWebJob>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<ContinuousWebJob>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<ContinuousWebJob>[]): ContinuousWebJob[]
concat(...items: (T | ConcatArray<T>)[]): ContinuousWebJob[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<ContinuousWebJob>[]
 
 Additional items to add to the end of array1.
Returns ContinuousWebJob[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns ContinuousWebJob[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, ContinuousWebJob]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, ContinuousWebJob]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): boolean
    - Parameters
      - value: ContinuousWebJob
      - index: number
      - array: ContinuousWebJob[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: ContinuousWebJob, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: ContinuousWebJob
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): ContinuousWebJob[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: ContinuousWebJob
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): boolean
    - Parameters
      - value: ContinuousWebJob
      - index: number
      - array: ContinuousWebJob[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): any
    - Parameters
      - value: ContinuousWebJob
      - index: number
      - array: ContinuousWebJob[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns ContinuousWebJob[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): ContinuousWebJob | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: ContinuousWebJob
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: ContinuousWebJob, index: number, obj: ContinuousWebJob[]): boolean
    - Parameters
      - this: void
      - value: ContinuousWebJob
      - index: number
      - obj: ContinuousWebJob[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: ContinuousWebJob, index: number, obj: ContinuousWebJob[]): boolean
    - Parameters
      - value: ContinuousWebJob
      - index: number
      - obj: ContinuousWebJob[]
      Returns boolean
- Optional thisArg: any
Returns ContinuousWebJob | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: ContinuousWebJob, index: number, obj: ContinuousWebJob[]): boolean
    - Parameters
      - value: ContinuousWebJob
      - index: number
      - obj: ContinuousWebJob[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): void
    - Parameters
      - value: ContinuousWebJob
      - index: number
      - array: ContinuousWebJob[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: ContinuousWebJob, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: ContinuousWebJob
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: ContinuousWebJob, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: ContinuousWebJob
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: ContinuousWebJob, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: ContinuousWebJob
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): U
    - Parameters
      - value: ContinuousWebJob
      - index: number
      - array: ContinuousWebJob[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): ContinuousWebJob | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns ContinuousWebJob | undefined

push

push(...items: ContinuousWebJob[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: ContinuousWebJob[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): ContinuousWebJob
reduce(callbackfn: function, initialValue: ContinuousWebJob): ContinuousWebJob
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ContinuousWebJob, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): ContinuousWebJob
    - Parameters
      - previousValue: ContinuousWebJob
      - currentValue: ContinuousWebJob
      - currentIndex: number
      - array: ContinuousWebJob[]
      Returns ContinuousWebJob
Returns ContinuousWebJob
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: ContinuousWebJob, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): ContinuousWebJob
    - Parameters
      - previousValue: ContinuousWebJob
      - currentValue: ContinuousWebJob
      - currentIndex: number
      - array: ContinuousWebJob[]
      Returns ContinuousWebJob
- initialValue: ContinuousWebJob
Returns ContinuousWebJob
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): U
    - Parameters
      - previousValue: U
      - currentValue: ContinuousWebJob
      - currentIndex: number
      - array: ContinuousWebJob[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): ContinuousWebJob
reduceRight(callbackfn: function, initialValue: ContinuousWebJob): ContinuousWebJob
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ContinuousWebJob, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): ContinuousWebJob
    - Parameters
      - previousValue: ContinuousWebJob
      - currentValue: ContinuousWebJob
      - currentIndex: number
      - array: ContinuousWebJob[]
      Returns ContinuousWebJob
Returns ContinuousWebJob
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: ContinuousWebJob, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): ContinuousWebJob
    - Parameters
      - previousValue: ContinuousWebJob
      - currentValue: ContinuousWebJob
      - currentIndex: number
      - array: ContinuousWebJob[]
      Returns ContinuousWebJob
- initialValue: ContinuousWebJob
Returns ContinuousWebJob
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ContinuousWebJob, currentIndex: number, array: ContinuousWebJob[]): U
    - Parameters
      - previousValue: U
      - currentValue: ContinuousWebJob
      - currentIndex: number
      - array: ContinuousWebJob[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): ContinuousWebJob[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns ContinuousWebJob[]

shift

shift(): ContinuousWebJob | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns ContinuousWebJob | undefined

slice

slice(start?: undefined | number, end?: undefined | number): ContinuousWebJob[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns ContinuousWebJob[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: ContinuousWebJob, index: number, array: ContinuousWebJob[]): boolean
    - Parameters
      - value: ContinuousWebJob
      - index: number
      - array: ContinuousWebJob[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): ContinuousWebJob[]
splice(start: number, deleteCount: number, ...items: ContinuousWebJob[]): ContinuousWebJob[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns ContinuousWebJob[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: ContinuousWebJob[]
  
  Elements to insert into the array in place of the deleted elements.
Returns ContinuousWebJob[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: ContinuousWebJob[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: ContinuousWebJob[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<ContinuousWebJob>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<ContinuousWebJob>

type

type: object

className

className: string = "ContinuousWebJobCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "ContinuousWebJob"

name

Const CorsSettings

CorsSettings: object

interface: An interface representing CorsSettings. Cross-Origin Resource Sharing (CORS) settings for the app.

Optional allowedOrigins

allowedOrigins: string[]

member: {string[]} [allowedOrigins] Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all.

serializedName

CsmMoveResourceEnvelope: object

interface: An interface representing CsmMoveResourceEnvelope. Object with a list of the resources that need to be moved and the resource group they should be moved to.

Optional resources

resources: string[]

member: {string[]} [resources]

serializedName

serializedName: string = "CsmMoveResourceEnvelope"

Optional targetResourceGroup

targetResourceGroup: undefined | string

member: {string} [targetResourceGroup]

type

type: object

className

className: string = "CsmMoveResourceEnvelope"

name

modelProperties

modelProperties: object

resources

resources: object

serializedName

serializedName: string = "resources"

type

type: object

name

element

element: object

type

type: object

name

targetResourceGroup

targetResourceGroup: object

serializedName

serializedName: string = "targetResourceGroup"

constraints

constraints: object

MaxLength

MaxLength: number = 90

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = / ^[-\w\._]+[^\.]$/

type

type: object

name

Const CsmOperationCollection

CsmOperationCollection: object

interface: An interface representing the CsmOperationCollection. Collection of Azure resource manager operation metadata.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CsmOperationCollection"

__@iterator

__@iterator(): IterableIterator<CsmOperationDescription>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<CsmOperationDescription>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<CsmOperationDescription>[]): CsmOperationDescription[]
concat(...items: (T | ConcatArray<T>)[]): CsmOperationDescription[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<CsmOperationDescription>[]
 
 Additional items to add to the end of array1.
Returns CsmOperationDescription[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns CsmOperationDescription[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, CsmOperationDescription]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, CsmOperationDescription]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): boolean
    - Parameters
      - value: CsmOperationDescription
      - index: number
      - array: CsmOperationDescription[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: CsmOperationDescription, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: CsmOperationDescription
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): CsmOperationDescription[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: CsmOperationDescription
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): boolean
    - Parameters
      - value: CsmOperationDescription
      - index: number
      - array: CsmOperationDescription[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): any
    - Parameters
      - value: CsmOperationDescription
      - index: number
      - array: CsmOperationDescription[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns CsmOperationDescription[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): CsmOperationDescription | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: CsmOperationDescription
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: CsmOperationDescription, index: number, obj: CsmOperationDescription[]): boolean
    - Parameters
      - this: void
      - value: CsmOperationDescription
      - index: number
      - obj: CsmOperationDescription[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: CsmOperationDescription, index: number, obj: CsmOperationDescription[]): boolean
    - Parameters
      - value: CsmOperationDescription
      - index: number
      - obj: CsmOperationDescription[]
      Returns boolean
- Optional thisArg: any
Returns CsmOperationDescription | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: CsmOperationDescription, index: number, obj: CsmOperationDescription[]): boolean
    - Parameters
      - value: CsmOperationDescription
      - index: number
      - obj: CsmOperationDescription[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): void
    - Parameters
      - value: CsmOperationDescription
      - index: number
      - array: CsmOperationDescription[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: CsmOperationDescription, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: CsmOperationDescription
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: CsmOperationDescription, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: CsmOperationDescription
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: CsmOperationDescription, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: CsmOperationDescription
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): U
    - Parameters
      - value: CsmOperationDescription
      - index: number
      - array: CsmOperationDescription[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): CsmOperationDescription | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns CsmOperationDescription | undefined

push

push(...items: CsmOperationDescription[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: CsmOperationDescription[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): CsmOperationDescription
reduce(callbackfn: function, initialValue: CsmOperationDescription): CsmOperationDescription
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: CsmOperationDescription, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): CsmOperationDescription
    - Parameters
      - previousValue: CsmOperationDescription
      - currentValue: CsmOperationDescription
      - currentIndex: number
      - array: CsmOperationDescription[]
      Returns CsmOperationDescription
Returns CsmOperationDescription
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: CsmOperationDescription, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): CsmOperationDescription
    - Parameters
      - previousValue: CsmOperationDescription
      - currentValue: CsmOperationDescription
      - currentIndex: number
      - array: CsmOperationDescription[]
      Returns CsmOperationDescription
- initialValue: CsmOperationDescription
Returns CsmOperationDescription
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): U
    - Parameters
      - previousValue: U
      - currentValue: CsmOperationDescription
      - currentIndex: number
      - array: CsmOperationDescription[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): CsmOperationDescription
reduceRight(callbackfn: function, initialValue: CsmOperationDescription): CsmOperationDescription
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: CsmOperationDescription, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): CsmOperationDescription
    - Parameters
      - previousValue: CsmOperationDescription
      - currentValue: CsmOperationDescription
      - currentIndex: number
      - array: CsmOperationDescription[]
      Returns CsmOperationDescription
Returns CsmOperationDescription
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: CsmOperationDescription, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): CsmOperationDescription
    - Parameters
      - previousValue: CsmOperationDescription
      - currentValue: CsmOperationDescription
      - currentIndex: number
      - array: CsmOperationDescription[]
      Returns CsmOperationDescription
- initialValue: CsmOperationDescription
Returns CsmOperationDescription
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: CsmOperationDescription, currentIndex: number, array: CsmOperationDescription[]): U
    - Parameters
      - previousValue: U
      - currentValue: CsmOperationDescription
      - currentIndex: number
      - array: CsmOperationDescription[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): CsmOperationDescription[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns CsmOperationDescription[]

shift

shift(): CsmOperationDescription | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns CsmOperationDescription | undefined

slice

slice(start?: undefined | number, end?: undefined | number): CsmOperationDescription[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns CsmOperationDescription[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: CsmOperationDescription, index: number, array: CsmOperationDescription[]): boolean
    - Parameters
      - value: CsmOperationDescription
      - index: number
      - array: CsmOperationDescription[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): CsmOperationDescription[]
splice(start: number, deleteCount: number, ...items: CsmOperationDescription[]): CsmOperationDescription[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns CsmOperationDescription[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: CsmOperationDescription[]
  
  Elements to insert into the array in place of the deleted elements.
Returns CsmOperationDescription[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: CsmOperationDescription[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: CsmOperationDescription[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<CsmOperationDescription>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<CsmOperationDescription>

type

type: object

className

className: string = "CsmOperationCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "CsmOperationDescription"

name

Const CsmOperationDescription

CsmOperationDescription: object

interface: An interface representing CsmOperationDescription. Description of an operation available for Microsoft.Web resource provider.

Optional display

display: CsmOperationDisplay

member: {CsmOperationDisplay} [display]

Optional name

member: {string} [name]

Optional origin

origin: undefined | string

member: {string} [origin]

Optional properties

properties: CsmOperationDescriptionProperties

member: {CsmOperationDescriptionProperties} [properties]

serializedName

serializedName: string = "CsmOperationDescription"

type

type: object

className

className: string = "CsmOperationDescription"

origin

origin: object

serializedName

serializedName: string = "origin"

type

type: object

name

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "CsmOperationDescriptionProperties"

name

Const CsmOperationDescriptionProperties

CsmOperationDescriptionProperties: object

interface: An interface representing CsmOperationDescriptionProperties. Properties available for a Microsoft.Web resource provider operation.

serializedName

serializedName: string = "CsmOperationDescriptionProperties"

Optional serviceSpecification

serviceSpecification: ServiceSpecification

member: {ServiceSpecification} [serviceSpecification]

type

type: object

className

className: string = "CsmOperationDescriptionProperties"

name

modelProperties

modelProperties: object

serviceSpecification

serviceSpecification: object

serializedName

serializedName: string = "serviceSpecification"

type

type: object

className

className: string = "ServiceSpecification"

name

Const CsmOperationDisplay

CsmOperationDisplay: object

interface: An interface representing CsmOperationDisplay. Meta data about operation used for display in portal.

Optional description

description: undefined | string

member: {string} [description]

Optional operation

operation: undefined | string

member: {string} [operation]

Optional provider

provider: undefined | string

member: {string} [provider]

Optional resource

resource: undefined | string

member: {string} [resource]

serializedName

serializedName: string = "CsmOperationDisplay"

type

type: object

className

className: string = "CsmOperationDisplay"

name

modelProperties

name

Const CsmPublishingProfileOptions

CsmPublishingProfileOptions: object

interface: An interface representing CsmPublishingProfileOptions. Publishing options for requested profile.

Optional format

format: PublishingProfileFormat

member: {PublishingProfileFormat} [format] Name of the format. Valid values are: FileZilla3 WebDeploy -- default Ftp. Possible values include: 'FileZilla3', 'WebDeploy', 'Ftp'

Optional includeDisasterRecoveryEndpoints

includeDisasterRecoveryEndpoints: undefined | false | true

member: {boolean} [includeDisasterRecoveryEndpoints] Include the DisasterRecover endpoint if true

serializedName

serializedName: string = "CsmPublishingProfileOptions"

type

type: object

className

className: string = "CsmPublishingProfileOptions"

name

modelProperties

modelProperties: object

format

format: object

serializedName

serializedName: string = "format"

type

type: object

name

includeDisasterRecoveryEndpoints

includeDisasterRecoveryEndpoints: object

serializedName

serializedName: string = "includeDisasterRecoveryEndpoints"

type

type: object

name

Const CsmSlotEntity

CsmSlotEntity: object

interface: An interface representing CsmSlotEntity. Deployment slot parameters.

preserveVnet

preserveVnet: boolean

member: {boolean} preserveVnet true to preserve Virtual Network to the slot during swap; otherwise, false.

serializedName

serializedName: string = "CsmSlotEntity"

targetSlot

targetSlot: string

member: {string} targetSlot Destination deployment slot during swap operation.

type

type: object

className

className: string = "CsmSlotEntity"

name

modelProperties

modelProperties: object

preserveVnet

preserveVnet: object

required

required: true = true

serializedName

serializedName: string = "preserveVnet"

type

type: object

name

targetSlot

targetSlot: object

required

required: true = true

serializedName

serializedName: string = "targetSlot"

type

type: object

name

Const CsmUsageQuota

CsmUsageQuota: object

interface: An interface representing CsmUsageQuota. Usage of the quota resource.

Optional currentValue

currentValue: undefined | number

member: {number} [currentValue] The current value of the resource counter.

Optional limit

limit: undefined | number

member: {number} [limit] The resource limit.

Optional name

member: {LocalizableString} [name] Quota name.

Optional nextResetTime

nextResetTime: Date

member: {Date} [nextResetTime] Next reset time for the resource counter.

serializedName

serializedName: string = "CsmUsageQuota"

Optional unit

unit: undefined | string

member: {string} [unit] Units of measurement for the quota resourse.

type

type: object

className

className: string = "CsmUsageQuota"

name

modelProperties

modelProperties: object

currentValue

currentValue: object

serializedName

serializedName: string = "currentValue"

type

type: object

name

limit

limit: object

serializedName

serializedName: string = "limit"

type

type: object

type: object

name

Const CsmUsageQuotaCollection

CsmUsageQuotaCollection: object

interface: An interface representing the CsmUsageQuotaCollection. Collection of CSM usage quotas.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CsmUsageQuotaCollection"

__@iterator

__@iterator(): IterableIterator<CsmUsageQuota>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<CsmUsageQuota>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<CsmUsageQuota>[]): CsmUsageQuota[]
concat(...items: (T | ConcatArray<T>)[]): CsmUsageQuota[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<CsmUsageQuota>[]
 
 Additional items to add to the end of array1.
Returns CsmUsageQuota[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns CsmUsageQuota[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, CsmUsageQuota]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, CsmUsageQuota]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): boolean
    - Parameters
      - value: CsmUsageQuota
      - index: number
      - array: CsmUsageQuota[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: CsmUsageQuota, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: CsmUsageQuota
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): CsmUsageQuota[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: CsmUsageQuota
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): boolean
    - Parameters
      - value: CsmUsageQuota
      - index: number
      - array: CsmUsageQuota[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): any
    - Parameters
      - value: CsmUsageQuota
      - index: number
      - array: CsmUsageQuota[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns CsmUsageQuota[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): CsmUsageQuota | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: CsmUsageQuota
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: CsmUsageQuota, index: number, obj: CsmUsageQuota[]): boolean
    - Parameters
      - this: void
      - value: CsmUsageQuota
      - index: number
      - obj: CsmUsageQuota[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: CsmUsageQuota, index: number, obj: CsmUsageQuota[]): boolean
    - Parameters
      - value: CsmUsageQuota
      - index: number
      - obj: CsmUsageQuota[]
      Returns boolean
- Optional thisArg: any
Returns CsmUsageQuota | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: CsmUsageQuota, index: number, obj: CsmUsageQuota[]): boolean
    - Parameters
      - value: CsmUsageQuota
      - index: number
      - obj: CsmUsageQuota[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): void
    - Parameters
      - value: CsmUsageQuota
      - index: number
      - array: CsmUsageQuota[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: CsmUsageQuota, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: CsmUsageQuota
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: CsmUsageQuota, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: CsmUsageQuota
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: CsmUsageQuota, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: CsmUsageQuota
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): U
    - Parameters
      - value: CsmUsageQuota
      - index: number
      - array: CsmUsageQuota[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): CsmUsageQuota | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns CsmUsageQuota | undefined

push

push(...items: CsmUsageQuota[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: CsmUsageQuota[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): CsmUsageQuota
reduce(callbackfn: function, initialValue: CsmUsageQuota): CsmUsageQuota
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: CsmUsageQuota, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): CsmUsageQuota
    - Parameters
      - previousValue: CsmUsageQuota
      - currentValue: CsmUsageQuota
      - currentIndex: number
      - array: CsmUsageQuota[]
      Returns CsmUsageQuota
Returns CsmUsageQuota
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: CsmUsageQuota, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): CsmUsageQuota
    - Parameters
      - previousValue: CsmUsageQuota
      - currentValue: CsmUsageQuota
      - currentIndex: number
      - array: CsmUsageQuota[]
      Returns CsmUsageQuota
- initialValue: CsmUsageQuota
Returns CsmUsageQuota
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): U
    - Parameters
      - previousValue: U
      - currentValue: CsmUsageQuota
      - currentIndex: number
      - array: CsmUsageQuota[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): CsmUsageQuota
reduceRight(callbackfn: function, initialValue: CsmUsageQuota): CsmUsageQuota
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: CsmUsageQuota, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): CsmUsageQuota
    - Parameters
      - previousValue: CsmUsageQuota
      - currentValue: CsmUsageQuota
      - currentIndex: number
      - array: CsmUsageQuota[]
      Returns CsmUsageQuota
Returns CsmUsageQuota
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: CsmUsageQuota, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): CsmUsageQuota
    - Parameters
      - previousValue: CsmUsageQuota
      - currentValue: CsmUsageQuota
      - currentIndex: number
      - array: CsmUsageQuota[]
      Returns CsmUsageQuota
- initialValue: CsmUsageQuota
Returns CsmUsageQuota
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: CsmUsageQuota, currentIndex: number, array: CsmUsageQuota[]): U
    - Parameters
      - previousValue: U
      - currentValue: CsmUsageQuota
      - currentIndex: number
      - array: CsmUsageQuota[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): CsmUsageQuota[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns CsmUsageQuota[]

shift

shift(): CsmUsageQuota | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns CsmUsageQuota | undefined

slice

slice(start?: undefined | number, end?: undefined | number): CsmUsageQuota[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns CsmUsageQuota[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: CsmUsageQuota, index: number, array: CsmUsageQuota[]): boolean
    - Parameters
      - value: CsmUsageQuota
      - index: number
      - array: CsmUsageQuota[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): CsmUsageQuota[]
splice(start: number, deleteCount: number, ...items: CsmUsageQuota[]): CsmUsageQuota[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns CsmUsageQuota[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: CsmUsageQuota[]
  
  Elements to insert into the array in place of the deleted elements.
Returns CsmUsageQuota[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: CsmUsageQuota[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: CsmUsageQuota[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<CsmUsageQuota>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<CsmUsageQuota>

type

type: object

className

className: string = "CsmUsageQuotaCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "CsmUsageQuota"

name

Const CustomHostnameAnalysisResult

CustomHostnameAnalysisResult: object

interface: An interface representing CustomHostnameAnalysisResult. Custom domain analysis.
extends: ProxyOnlyResource

Optional aRecords

aRecords: string[]

member: {string[]} [aRecords] A records controller can see for this hostname.

Optional alternateCNameRecords

alternateCNameRecords: string[]

member: {string[]} [alternateCNameRecords] Alternate CName records controller can see for this hostname.

Optional alternateTxtRecords

alternateTxtRecords: string[]

member: {string[]} [alternateTxtRecords] Alternate TXT records controller can see for this hostname.

Optional cNameRecords

cNameRecords: string[]

member: {string[]} [cNameRecords] CName records controller can see for this hostname.

Optional conflictingAppResourceId

conflictingAppResourceId: undefined | string

member: {string} [conflictingAppResourceId] Name of the conflicting app on scale unit if it's within the same subscription. NOTE: This property will not be serialized. It can only be populated by the server.

Optional customDomainVerificationFailureInfo

customDomainVerificationFailureInfo: ErrorEntity

member: {ErrorEntity} [customDomainVerificationFailureInfo] Raw failure information if DNS verification fails. NOTE: This property will not be serialized. It can only be populated by the server.

Optional customDomainVerificationTest

customDomainVerificationTest: DnsVerificationTestResult

member: {DnsVerificationTestResult} [customDomainVerificationTest] DNS verification test result. Possible values include: 'Passed', 'Failed', 'Skipped' NOTE: This property will not be serialized. It can only be populated by the server.

Optional hasConflictAcrossSubscription

hasConflictAcrossSubscription: undefined | false | true

member: {boolean} [hasConflictAcrossSubscription] true if htere is a conflict across subscriptions; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hasConflictOnScaleUnit

hasConflictOnScaleUnit: undefined | false | true

member: {boolean} [hasConflictOnScaleUnit] true if there is a conflict on a scale unit; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isHostnameAlreadyVerified

isHostnameAlreadyVerified: undefined | false | true

member: {boolean} [isHostnameAlreadyVerified] true if hostname is already verified; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "CustomHostnameAnalysisResult"

Optional txtRecords

txtRecords: string[]

member: {string[]} [txtRecords] TXT records controller can see for this hostname.

type

type: object

className

className: string = "CustomHostnameAnalysisResult"

name

modelProperties

type

type: object

className

className: string = "ErrorEntity"

name

customDomainVerificationTest

name

txtRecords

txtRecords: object

serializedName

serializedName: string = "properties.txtRecords"

type

type: object

name

element

element: object

type

type: object

name

Const DataSource

DataSource: object

interface: An interface representing DataSource. Class representing data source used by the detectors

Optional dataSourceUri

dataSourceUri: NameValuePair[]

member: {NameValuePair[]} [dataSourceUri] Datasource Uri Links

Optional instructions

instructions: string[]

member: {string[]} [instructions] Instrunctions if any for the data source

serializedName

serializedName: string = "DataSource"

type

type: object

className

className: string = "DataSource"

name

modelProperties

name

element

element: object

type

type: object

name

Const DataTableResponseColumn

DataTableResponseColumn: object

interface: An interface representing DataTableResponseColumn. Column definition

Optional columnName

columnName: undefined | string

member: {string} [columnName] Name of the column

Optional columnType

columnType: undefined | string

member: {string} [columnType] Column Type

Optional dataType

dataType: undefined | string

member: {string} [dataType] Data type which looks like 'String' or 'Int32'.

serializedName

serializedName: string = "DataTableResponseColumn"

type

type: object

className

className: string = "DataTableResponseColumn"

name

modelProperties

name

Const DataTableResponseObject

DataTableResponseObject: object

interface: An interface representing DataTableResponseObject. Data Table which defines columns and raw row values

Optional columns

columns: DataTableResponseColumn[]

member: {DataTableResponseColumn[]} [columns] List of columns with data types

Optional rows

rows: string[][]

member: {string[][]} [rows] Raw row values

serializedName

serializedName: string = "DataTableResponseObject"

Optional tableName

tableName: undefined | string

member: {string} [tableName] Name of the table

type

type: object

className

className: string = "DataTableResponseObject"

name

modelProperties

name

element

element: object

type

type: object

name

element

element: object

type

type: object

name

tableName

tableName: object

serializedName

serializedName: string = "tableName"

type

type: object

name

Const DatabaseBackupSetting

DatabaseBackupSetting: object

interface: An interface representing DatabaseBackupSetting. Database backup settings.

Optional connectionString

connectionString: undefined | string

member: {string} [connectionString] Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.

Optional connectionStringName

connectionStringName: undefined | string

member: {string} [connectionStringName] Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. This is used during restore with overwrite connection strings options.

databaseType

databaseType: DatabaseType

member: {DatabaseType} databaseType Database type (e.g. SqlAzure / MySql). Possible values include: 'SqlAzure', 'MySql', 'LocalMySql', 'PostgreSql'

Optional name

member: {string} [name]

serializedName

serializedName: string = "DatabaseBackupSetting"

type

type: object

className

className: string = "DatabaseBackupSetting"

name

modelProperties

type

type: object

name

name

serializedName

serializedName: string = "name"

type

type: object

name

Const DefaultErrorResponse

DefaultErrorResponse: object

interface: An interface representing DefaultErrorResponse. App Service error response.

Optional error

error: DefaultErrorResponseError

member: {DefaultErrorResponseError} [error] Error model. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DefaultErrorResponse"

type

type: object

className

className: string = "DefaultErrorResponse"

name

modelProperties

modelProperties: object

error

error: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "DefaultErrorResponseError"

name

Const DefaultErrorResponseError

DefaultErrorResponseError: object

interface: An interface representing DefaultErrorResponseError. Error model.

Optional code

code: undefined | string

member: {string} [code] Standardized string to programmatically identify the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional details

details: DefaultErrorResponseErrorDetailsItem[]

member: {DefaultErrorResponseErrorDetailsItem[]} [details]

Optional innererror

innererror: undefined | string

member: {string} [innererror] More information to debug error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional message

message: undefined | string

member: {string} [message] Detailed error description and debugging information. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DefaultErrorResponse_error"

Optional target

target: undefined | string

member: {string} [target] Detailed error description and debugging information. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "DefaultErrorResponseError"

name

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "code"

type

type: object

name

details

details: object

serializedName

serializedName: string = "details"

type

type: object

DefaultErrorResponseErrorDetailsItem: object

interface: An interface representing DefaultErrorResponseErrorDetailsItem. Detailed errors.

Optional code

code: undefined | string

member: {string} [code] Standardized string to programmatically identify the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional message

message: undefined | string

member: {string} [message] Detailed error description and debugging information. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DefaultErrorResponse_error_detailsItem"

Optional target

target: undefined | string

member: {string} [target] Detailed error description and debugging information. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "DefaultErrorResponseErrorDetailsItem"

name

modelProperties

name

Const DeletedAppRestoreRequest

DeletedAppRestoreRequest: object

interface: An interface representing DeletedAppRestoreRequest. Details about restoring a deleted app.
extends: ProxyOnlyResource

Optional deletedSiteId

deletedSiteId: undefined | string

member: {string} [deletedSiteId] ARM resource ID of the deleted app. Example: /subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional recoverConfiguration

recoverConfiguration: undefined | false | true

member: {boolean} [recoverConfiguration] If true, deleted site configuration, in addition to content, will be restored.

serializedName

serializedName: string = "DeletedAppRestoreRequest"

Optional snapshotTime

snapshotTime: undefined | string

member: {string} [snapshotTime] Point in time to restore the deleted app from, formatted as a DateTime string. If unspecified, default value is the time that the app was deleted.

Optional useDRSecondary

useDRSecondary: undefined | false | true

member: {boolean} [useDRSecondary] If true, the snapshot is retrieved from DRSecondary endpoint.

type

type: object

className

className: string = "DeletedAppRestoreRequest"

name

modelProperties

name

Const DeletedSite

DeletedSite: object

interface: An interface representing DeletedSite. A deleted app.
extends: ProxyOnlyResource

Optional deletedSiteId

deletedSiteId: undefined | number

member: {number} [deletedSiteId] Numeric id for the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

Optional deletedSiteKind

deletedSiteKind: undefined | string

member: {string} [deletedSiteKind] Kind of site that was deleted NOTE: This property will not be serialized. It can only be populated by the server.

Optional deletedSiteName

deletedSiteName: undefined | string

member: {string} [deletedSiteName] Name of the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

Optional deletedTimestamp

deletedTimestamp: undefined | string

member: {string} [deletedTimestamp] Time in UTC when the app was deleted. NOTE: This property will not be serialized. It can only be populated by the server.

Optional geoRegionName

geoRegionName: undefined | string

member: {string} [geoRegionName] Geo Region of the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceGroup

resourceGroup: undefined | string

member: {string} [resourceGroup] ResourceGroup that contained the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DeletedSite"

Optional slot

slot: undefined | string

member: {string} [slot] Slot of the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

Optional subscription

subscription: undefined | string

member: {string} [subscription] Subscription containing the deleted site NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "DeletedSite"

name

modelProperties

name

Const DeletedWebAppCollection

DeletedWebAppCollection: object

interface: An interface representing the DeletedWebAppCollection. Collection of deleted apps.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DeletedWebAppCollection"

__@iterator

__@iterator(): IterableIterator<DeletedSite>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<DeletedSite>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<DeletedSite>[]): DeletedSite[]
concat(...items: (T | ConcatArray<T>)[]): DeletedSite[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<DeletedSite>[]
 
 Additional items to add to the end of array1.
Returns DeletedSite[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns DeletedSite[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, DeletedSite]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, DeletedSite]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: DeletedSite, index: number, array: DeletedSite[]): boolean
    - Parameters
      - value: DeletedSite
      - index: number
      - array: DeletedSite[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: DeletedSite, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: DeletedSite
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): DeletedSite[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: DeletedSite
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: DeletedSite, index: number, array: DeletedSite[]): boolean
    - Parameters
      - value: DeletedSite
      - index: number
      - array: DeletedSite[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: DeletedSite, index: number, array: DeletedSite[]): any
    - Parameters
      - value: DeletedSite
      - index: number
      - array: DeletedSite[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns DeletedSite[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): DeletedSite | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: DeletedSite
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: DeletedSite, index: number, obj: DeletedSite[]): boolean
    - Parameters
      - this: void
      - value: DeletedSite
      - index: number
      - obj: DeletedSite[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: DeletedSite, index: number, obj: DeletedSite[]): boolean
    - Parameters
      - value: DeletedSite
      - index: number
      - obj: DeletedSite[]
      Returns boolean
- Optional thisArg: any
Returns DeletedSite | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: DeletedSite, index: number, obj: DeletedSite[]): boolean
    - Parameters
      - value: DeletedSite
      - index: number
      - obj: DeletedSite[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: DeletedSite, index: number, array: DeletedSite[]): void
    - Parameters
      - value: DeletedSite
      - index: number
      - array: DeletedSite[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: DeletedSite, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: DeletedSite
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: DeletedSite, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: DeletedSite
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: DeletedSite, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: DeletedSite
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: DeletedSite, index: number, array: DeletedSite[]): U
    - Parameters
      - value: DeletedSite
      - index: number
      - array: DeletedSite[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): DeletedSite | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns DeletedSite | undefined

push

push(...items: DeletedSite[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: DeletedSite[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): DeletedSite
reduce(callbackfn: function, initialValue: DeletedSite): DeletedSite
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: DeletedSite, currentValue: DeletedSite, currentIndex: number, array: DeletedSite[]): DeletedSite
    - Parameters
      - previousValue: DeletedSite
      - currentValue: DeletedSite
      - currentIndex: number
      - array: DeletedSite[]
      Returns DeletedSite
Returns DeletedSite
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: DeletedSite, currentValue: DeletedSite, currentIndex: number, array: DeletedSite[]): DeletedSite
    - Parameters
      - previousValue: DeletedSite
      - currentValue: DeletedSite
      - currentIndex: number
      - array: DeletedSite[]
      Returns DeletedSite
- initialValue: DeletedSite
Returns DeletedSite
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: DeletedSite, currentIndex: number, array: DeletedSite[]): U
    - Parameters
      - previousValue: U
      - currentValue: DeletedSite
      - currentIndex: number
      - array: DeletedSite[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): DeletedSite
reduceRight(callbackfn: function, initialValue: DeletedSite): DeletedSite
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: DeletedSite, currentValue: DeletedSite, currentIndex: number, array: DeletedSite[]): DeletedSite
    - Parameters
      - previousValue: DeletedSite
      - currentValue: DeletedSite
      - currentIndex: number
      - array: DeletedSite[]
      Returns DeletedSite
Returns DeletedSite
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: DeletedSite, currentValue: DeletedSite, currentIndex: number, array: DeletedSite[]): DeletedSite
    - Parameters
      - previousValue: DeletedSite
      - currentValue: DeletedSite
      - currentIndex: number
      - array: DeletedSite[]
      Returns DeletedSite
- initialValue: DeletedSite
Returns DeletedSite
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: DeletedSite, currentIndex: number, array: DeletedSite[]): U
    - Parameters
      - previousValue: U
      - currentValue: DeletedSite
      - currentIndex: number
      - array: DeletedSite[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): DeletedSite[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns DeletedSite[]

shift

shift(): DeletedSite | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns DeletedSite | undefined

slice

slice(start?: undefined | number, end?: undefined | number): DeletedSite[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns DeletedSite[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: DeletedSite, index: number, array: DeletedSite[]): boolean
    - Parameters
      - value: DeletedSite
      - index: number
      - array: DeletedSite[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): DeletedSite[]
splice(start: number, deleteCount: number, ...items: DeletedSite[]): DeletedSite[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns DeletedSite[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: DeletedSite[]
  
  Elements to insert into the array in place of the deleted elements.
Returns DeletedSite[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: DeletedSite[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: DeletedSite[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<DeletedSite>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<DeletedSite>

type

type: object

className

className: string = "DeletedWebAppCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "DeletedSite"

name

Const Deployment

Deployment: object

interface: An interface representing Deployment. User crendentials used for publishing activity.
extends: ProxyOnlyResource

Optional active

active: undefined | false | true

member: {boolean} [active] True if deployment is currently active, false if completed and null if not started.

Optional author

author: undefined | string

member: {string} [author] Who authored the deployment.

Optional authorEmail

authorEmail: undefined | string

member: {string} [authorEmail] Author email.

Optional deployer

deployer: undefined | string

member: {string} [deployer] Who performed the deployment.

Optional details

details: undefined | string

member: {string} [details] Details on deployment.

Optional endTime

endTime: Date

member: {Date} [endTime] End time.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional message

message: undefined | string

member: {string} [message] Details about deployment status.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Deployment"

Optional startTime

startTime: Date

member: {Date} [startTime] Start time.

Optional status

status: undefined | number

member: {number} [status] Deployment status.

type

type: object

className

className: string = "Deployment"

name

modelProperties

name

Const DeploymentCollection

DeploymentCollection: object

interface: An interface representing the DeploymentCollection. Collection of app deployments.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DeploymentCollection"

__@iterator

__@iterator(): IterableIterator<Deployment>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<Deployment>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<Deployment>[]): Deployment[]
concat(...items: (T | ConcatArray<T>)[]): Deployment[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<Deployment>[]
 
 Additional items to add to the end of array1.
Returns Deployment[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns Deployment[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, Deployment]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, Deployment]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: Deployment, index: number, array: Deployment[]): boolean
    - Parameters
      - value: Deployment
      - index: number
      - array: Deployment[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: Deployment, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: Deployment
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): Deployment[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: Deployment
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Deployment, index: number, array: Deployment[]): boolean
    - Parameters
      - value: Deployment
      - index: number
      - array: Deployment[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Deployment, index: number, array: Deployment[]): any
    - Parameters
      - value: Deployment
      - index: number
      - array: Deployment[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Deployment[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): Deployment | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: Deployment
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: Deployment, index: number, obj: Deployment[]): boolean
    - Parameters
      - this: void
      - value: Deployment
      - index: number
      - obj: Deployment[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: Deployment, index: number, obj: Deployment[]): boolean
    - Parameters
      - value: Deployment
      - index: number
      - obj: Deployment[]
      Returns boolean
- Optional thisArg: any
Returns Deployment | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: Deployment, index: number, obj: Deployment[]): boolean
    - Parameters
      - value: Deployment
      - index: number
      - obj: Deployment[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: Deployment, index: number, array: Deployment[]): void
    - Parameters
      - value: Deployment
      - index: number
      - array: Deployment[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: Deployment, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: Deployment
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: Deployment, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: Deployment
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: Deployment, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: Deployment
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: Deployment, index: number, array: Deployment[]): U
    - Parameters
      - value: Deployment
      - index: number
      - array: Deployment[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): Deployment | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns Deployment | undefined

push

push(...items: Deployment[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: Deployment[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): Deployment
reduce(callbackfn: function, initialValue: Deployment): Deployment
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Deployment, currentValue: Deployment, currentIndex: number, array: Deployment[]): Deployment
    - Parameters
      - previousValue: Deployment
      - currentValue: Deployment
      - currentIndex: number
      - array: Deployment[]
      Returns Deployment
Returns Deployment
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: Deployment, currentValue: Deployment, currentIndex: number, array: Deployment[]): Deployment
    - Parameters
      - previousValue: Deployment
      - currentValue: Deployment
      - currentIndex: number
      - array: Deployment[]
      Returns Deployment
- initialValue: Deployment
Returns Deployment
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Deployment, currentIndex: number, array: Deployment[]): U
    - Parameters
      - previousValue: U
      - currentValue: Deployment
      - currentIndex: number
      - array: Deployment[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): Deployment
reduceRight(callbackfn: function, initialValue: Deployment): Deployment
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Deployment, currentValue: Deployment, currentIndex: number, array: Deployment[]): Deployment
    - Parameters
      - previousValue: Deployment
      - currentValue: Deployment
      - currentIndex: number
      - array: Deployment[]
      Returns Deployment
Returns Deployment
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: Deployment, currentValue: Deployment, currentIndex: number, array: Deployment[]): Deployment
    - Parameters
      - previousValue: Deployment
      - currentValue: Deployment
      - currentIndex: number
      - array: Deployment[]
      Returns Deployment
- initialValue: Deployment
Returns Deployment
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Deployment, currentIndex: number, array: Deployment[]): U
    - Parameters
      - previousValue: U
      - currentValue: Deployment
      - currentIndex: number
      - array: Deployment[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): Deployment[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns Deployment[]

shift

shift(): Deployment | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns Deployment | undefined

slice

slice(start?: undefined | number, end?: undefined | number): Deployment[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns Deployment[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: Deployment, index: number, array: Deployment[]): boolean
    - Parameters
      - value: Deployment
      - index: number
      - array: Deployment[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): Deployment[]
splice(start: number, deleteCount: number, ...items: Deployment[]): Deployment[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns Deployment[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: Deployment[]
  
  Elements to insert into the array in place of the deleted elements.
Returns Deployment[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: Deployment[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: Deployment[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<Deployment>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<Deployment>

type

type: object

className

className: string = "DeploymentCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "Deployment"

name

Const DeploymentLocations

DeploymentLocations: object

interface: An interface representing DeploymentLocations. List of available locations (regions or App Service Environments) for deployment of App Service resources.

Optional hostingEnvironmentDeploymentInfos

hostingEnvironmentDeploymentInfos: HostingEnvironmentDeploymentInfo[]

member: {HostingEnvironmentDeploymentInfo[]} [hostingEnvironmentDeploymentInfos] Available App Service Environments with basic information.

Optional hostingEnvironments

hostingEnvironments: AppServiceEnvironment[]

member: {AppServiceEnvironment[]} [hostingEnvironments] Available App Service Environments with full descriptions of the environments.

Optional locations

locations: GeoRegion[]

member: {GeoRegion[]} [locations] Available regions.

serializedName

serializedName: string = "DeploymentLocations"

type

type: object

className

className: string = "DeploymentLocations"

name

modelProperties

name

Const DetectorAbnormalTimePeriod

DetectorAbnormalTimePeriod: object

interface: An interface representing DetectorAbnormalTimePeriod. Class representing Abnormal Time Period detected.

Optional endTime

endTime: Date

member: {Date} [endTime] End time of the corelated event

Optional message

message: undefined | string

member: {string} [message] Message describing the event

Optional metaData

metaData: NameValuePair[][]

member: {NameValuePair[][]} [metaData] Downtime metadata

Optional priority

priority: undefined | number

member: {number} [priority] Represents the rank of the Detector

serializedName

serializedName: string = "DetectorAbnormalTimePeriod"

Optional solutions

solutions: Solution[]

member: {Solution[]} [solutions] List of proposed solutions

Optional source

source: undefined | string

member: {string} [source] Represents the name of the Detector

Optional startTime

startTime: Date

member: {Date} [startTime] Start time of the corelated event

type

type: object

member: {IssueType} [type] Represents the type of the Detector. Possible values include: 'ServiceIncident', 'AppDeployment', 'AppCrash', 'RuntimeIssueDetected', 'AseDeployment', 'UserIssue', 'PlatformIssue', 'Other'

className

className: string = "DetectorAbnormalTimePeriod"

name

modelProperties

type: object

serializedName

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["ServiceIncident","AppDeployment","AppCrash","RuntimeIssueDetected","AseDeployment","UserIssue","PlatformIssue","Other"]

name

Const DetectorDefinition

DetectorDefinition: object

interface: An interface representing DetectorDefinition. Class representing detector definition
extends: ProxyOnlyResource

Optional description

description: undefined | string

member: {string} [description] Description of the detector NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayName

displayName: undefined | string

member: {string} [displayName] Display name of the detector NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isEnabled

isEnabled: undefined | false | true

member: {boolean} [isEnabled] Flag representing whether detector is enabled or not. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional rank

rank: undefined | number

member: {number} [rank] Detector Rank NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DetectorDefinition"

type

type: object

className

className: string = "DetectorDefinition"

name

modelProperties

name

Const DetectorInfo

DetectorInfo: object

interface: An interface representing DetectorInfo. Definition of Detector

Optional category

category: undefined | string

member: {string} [category] Support Category NOTE: This property will not be serialized. It can only be populated by the server.

Optional description

description: undefined | string

member: {string} [description] Short description of the detector and its purpose NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DetectorInfo"

Optional subCategory

subCategory: undefined | string

member: {string} [subCategory] Support Sub Category NOTE: This property will not be serialized. It can only be populated by the server.

Optional supportTopicId

supportTopicId: undefined | string

member: {string} [supportTopicId] Support Topic Id NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "supportTopicId"

type

type: object

name

Const DetectorResponse

DetectorResponse: object

interface: An interface representing DetectorResponse. Class representing Response from Detector
extends: ProxyOnlyResource

Optional dataset

dataset: DiagnosticData[]

member: {DiagnosticData[]} [dataset] Data Set

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional metadata

metadata: DetectorInfo

member: {DetectorInfo} [metadata] metadata for the detector

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DetectorResponse"

type

type: object

className

className: string = "DetectorResponse"

name

modelProperties

className

className: string = "DetectorInfo"

name

Const DetectorResponseCollection

DetectorResponseCollection: object

interface: An interface representing the DetectorResponseCollection. Collection of detector responses
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DetectorResponseCollection"

__@iterator

__@iterator(): IterableIterator<DetectorResponse>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<DetectorResponse>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<DetectorResponse>[]): DetectorResponse[]
concat(...items: (T | ConcatArray<T>)[]): DetectorResponse[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<DetectorResponse>[]
 
 Additional items to add to the end of array1.
Returns DetectorResponse[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns DetectorResponse[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, DetectorResponse]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, DetectorResponse]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: DetectorResponse, index: number, array: DetectorResponse[]): boolean
    - Parameters
      - value: DetectorResponse
      - index: number
      - array: DetectorResponse[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: DetectorResponse, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: DetectorResponse
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): DetectorResponse[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: DetectorResponse
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: DetectorResponse, index: number, array: DetectorResponse[]): boolean
    - Parameters
      - value: DetectorResponse
      - index: number
      - array: DetectorResponse[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: DetectorResponse, index: number, array: DetectorResponse[]): any
    - Parameters
      - value: DetectorResponse
      - index: number
      - array: DetectorResponse[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns DetectorResponse[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): DetectorResponse | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: DetectorResponse
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: DetectorResponse, index: number, obj: DetectorResponse[]): boolean
    - Parameters
      - this: void
      - value: DetectorResponse
      - index: number
      - obj: DetectorResponse[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: DetectorResponse, index: number, obj: DetectorResponse[]): boolean
    - Parameters
      - value: DetectorResponse
      - index: number
      - obj: DetectorResponse[]
      Returns boolean
- Optional thisArg: any
Returns DetectorResponse | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: DetectorResponse, index: number, obj: DetectorResponse[]): boolean
    - Parameters
      - value: DetectorResponse
      - index: number
      - obj: DetectorResponse[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: DetectorResponse, index: number, array: DetectorResponse[]): void
    - Parameters
      - value: DetectorResponse
      - index: number
      - array: DetectorResponse[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: DetectorResponse, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: DetectorResponse
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: DetectorResponse, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: DetectorResponse
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: DetectorResponse, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: DetectorResponse
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: DetectorResponse, index: number, array: DetectorResponse[]): U
    - Parameters
      - value: DetectorResponse
      - index: number
      - array: DetectorResponse[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): DetectorResponse | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns DetectorResponse | undefined

push

push(...items: DetectorResponse[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: DetectorResponse[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): DetectorResponse
reduce(callbackfn: function, initialValue: DetectorResponse): DetectorResponse
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: DetectorResponse, currentValue: DetectorResponse, currentIndex: number, array: DetectorResponse[]): DetectorResponse
    - Parameters
      - previousValue: DetectorResponse
      - currentValue: DetectorResponse
      - currentIndex: number
      - array: DetectorResponse[]
      Returns DetectorResponse
Returns DetectorResponse
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: DetectorResponse, currentValue: DetectorResponse, currentIndex: number, array: DetectorResponse[]): DetectorResponse
    - Parameters
      - previousValue: DetectorResponse
      - currentValue: DetectorResponse
      - currentIndex: number
      - array: DetectorResponse[]
      Returns DetectorResponse
- initialValue: DetectorResponse
Returns DetectorResponse
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: DetectorResponse, currentIndex: number, array: DetectorResponse[]): U
    - Parameters
      - previousValue: U
      - currentValue: DetectorResponse
      - currentIndex: number
      - array: DetectorResponse[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): DetectorResponse
reduceRight(callbackfn: function, initialValue: DetectorResponse): DetectorResponse
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: DetectorResponse, currentValue: DetectorResponse, currentIndex: number, array: DetectorResponse[]): DetectorResponse
    - Parameters
      - previousValue: DetectorResponse
      - currentValue: DetectorResponse
      - currentIndex: number
      - array: DetectorResponse[]
      Returns DetectorResponse
Returns DetectorResponse
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: DetectorResponse, currentValue: DetectorResponse, currentIndex: number, array: DetectorResponse[]): DetectorResponse
    - Parameters
      - previousValue: DetectorResponse
      - currentValue: DetectorResponse
      - currentIndex: number
      - array: DetectorResponse[]
      Returns DetectorResponse
- initialValue: DetectorResponse
Returns DetectorResponse
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: DetectorResponse, currentIndex: number, array: DetectorResponse[]): U
    - Parameters
      - previousValue: U
      - currentValue: DetectorResponse
      - currentIndex: number
      - array: DetectorResponse[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): DetectorResponse[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns DetectorResponse[]

shift

shift(): DetectorResponse | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns DetectorResponse | undefined

slice

slice(start?: undefined | number, end?: undefined | number): DetectorResponse[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns DetectorResponse[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: DetectorResponse, index: number, array: DetectorResponse[]): boolean
    - Parameters
      - value: DetectorResponse
      - index: number
      - array: DetectorResponse[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): DetectorResponse[]
splice(start: number, deleteCount: number, ...items: DetectorResponse[]): DetectorResponse[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns DetectorResponse[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: DetectorResponse[]
  
  Elements to insert into the array in place of the deleted elements.
Returns DetectorResponse[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: DetectorResponse[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: DetectorResponse[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<DetectorResponse>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<DetectorResponse>

type

type: object

className

className: string = "DetectorResponseCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "DetectorResponse"

name

Const DiagnosticAnalysis

DiagnosticAnalysis: object

interface: An interface representing DiagnosticAnalysis. Class representing a diagnostic analysis done on an application
extends: ProxyOnlyResource

Optional abnormalTimePeriods

abnormalTimePeriods: AbnormalTimePeriod[]

member: {AbnormalTimePeriod[]} [abnormalTimePeriods] List of time periods.

Optional endTime

endTime: Date

member: {Date} [endTime] End time of the period

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nonCorrelatedDetectors

nonCorrelatedDetectors: DetectorDefinition[]

member: {DetectorDefinition[]} [nonCorrelatedDetectors] Data by each detector for detectors that did not corelate

Optional payload

payload: AnalysisData[]

member: {AnalysisData[]} [payload] Data by each detector

serializedName

serializedName: string = "DiagnosticAnalysis"

Optional startTime

startTime: Date

member: {Date} [startTime] Start time of the period

type

type: object

className

className: string = "DiagnosticAnalysis"

name

modelProperties

name

Const DiagnosticAnalysisCollection

DiagnosticAnalysisCollection: object

interface: An interface representing the DiagnosticAnalysisCollection. Collection of Diagnostic Analyses
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DiagnosticAnalysisCollection"

__@iterator

__@iterator(): IterableIterator<AnalysisDefinition>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<AnalysisDefinition>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<AnalysisDefinition>[]): AnalysisDefinition[]
concat(...items: (T | ConcatArray<T>)[]): AnalysisDefinition[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<AnalysisDefinition>[]
 
 Additional items to add to the end of array1.
Returns AnalysisDefinition[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns AnalysisDefinition[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, AnalysisDefinition]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, AnalysisDefinition]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: AnalysisDefinition, index: number, array: AnalysisDefinition[]): boolean
    - Parameters
      - value: AnalysisDefinition
      - index: number
      - array: AnalysisDefinition[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: AnalysisDefinition, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: AnalysisDefinition
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): AnalysisDefinition[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: AnalysisDefinition
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: AnalysisDefinition, index: number, array: AnalysisDefinition[]): boolean
    - Parameters
      - value: AnalysisDefinition
      - index: number
      - array: AnalysisDefinition[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: AnalysisDefinition, index: number, array: AnalysisDefinition[]): any
    - Parameters
      - value: AnalysisDefinition
      - index: number
      - array: AnalysisDefinition[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns AnalysisDefinition[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): AnalysisDefinition | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: AnalysisDefinition
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: AnalysisDefinition, index: number, obj: AnalysisDefinition[]): boolean
    - Parameters
      - this: void
      - value: AnalysisDefinition
      - index: number
      - obj: AnalysisDefinition[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: AnalysisDefinition, index: number, obj: AnalysisDefinition[]): boolean
    - Parameters
      - value: AnalysisDefinition
      - index: number
      - obj: AnalysisDefinition[]
      Returns boolean
- Optional thisArg: any
Returns AnalysisDefinition | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: AnalysisDefinition, index: number, obj: AnalysisDefinition[]): boolean
    - Parameters
      - value: AnalysisDefinition
      - index: number
      - obj: AnalysisDefinition[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: AnalysisDefinition, index: number, array: AnalysisDefinition[]): void
    - Parameters
      - value: AnalysisDefinition
      - index: number
      - array: AnalysisDefinition[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: AnalysisDefinition, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: AnalysisDefinition
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: AnalysisDefinition, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: AnalysisDefinition
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: AnalysisDefinition, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: AnalysisDefinition
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: AnalysisDefinition, index: number, array: AnalysisDefinition[]): U
    - Parameters
      - value: AnalysisDefinition
      - index: number
      - array: AnalysisDefinition[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): AnalysisDefinition | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns AnalysisDefinition | undefined

push

push(...items: AnalysisDefinition[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: AnalysisDefinition[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): AnalysisDefinition
reduce(callbackfn: function, initialValue: AnalysisDefinition): AnalysisDefinition
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: AnalysisDefinition, currentValue: AnalysisDefinition, currentIndex: number, array: AnalysisDefinition[]): AnalysisDefinition
    - Parameters
      - previousValue: AnalysisDefinition
      - currentValue: AnalysisDefinition
      - currentIndex: number
      - array: AnalysisDefinition[]
      Returns AnalysisDefinition
Returns AnalysisDefinition
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: AnalysisDefinition, currentValue: AnalysisDefinition, currentIndex: number, array: AnalysisDefinition[]): AnalysisDefinition
    - Parameters
      - previousValue: AnalysisDefinition
      - currentValue: AnalysisDefinition
      - currentIndex: number
      - array: AnalysisDefinition[]
      Returns AnalysisDefinition
- initialValue: AnalysisDefinition
Returns AnalysisDefinition
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: AnalysisDefinition, currentIndex: number, array: AnalysisDefinition[]): U
    - Parameters
      - previousValue: U
      - currentValue: AnalysisDefinition
      - currentIndex: number
      - array: AnalysisDefinition[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): AnalysisDefinition
reduceRight(callbackfn: function, initialValue: AnalysisDefinition): AnalysisDefinition
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: AnalysisDefinition, currentValue: AnalysisDefinition, currentIndex: number, array: AnalysisDefinition[]): AnalysisDefinition
    - Parameters
      - previousValue: AnalysisDefinition
      - currentValue: AnalysisDefinition
      - currentIndex: number
      - array: AnalysisDefinition[]
      Returns AnalysisDefinition
Returns AnalysisDefinition
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: AnalysisDefinition, currentValue: AnalysisDefinition, currentIndex: number, array: AnalysisDefinition[]): AnalysisDefinition
    - Parameters
      - previousValue: AnalysisDefinition
      - currentValue: AnalysisDefinition
      - currentIndex: number
      - array: AnalysisDefinition[]
      Returns AnalysisDefinition
- initialValue: AnalysisDefinition
Returns AnalysisDefinition
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: AnalysisDefinition, currentIndex: number, array: AnalysisDefinition[]): U
    - Parameters
      - previousValue: U
      - currentValue: AnalysisDefinition
      - currentIndex: number
      - array: AnalysisDefinition[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): AnalysisDefinition[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns AnalysisDefinition[]

shift

shift(): AnalysisDefinition | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns AnalysisDefinition | undefined

slice

slice(start?: undefined | number, end?: undefined | number): AnalysisDefinition[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns AnalysisDefinition[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: AnalysisDefinition, index: number, array: AnalysisDefinition[]): boolean
    - Parameters
      - value: AnalysisDefinition
      - index: number
      - array: AnalysisDefinition[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): AnalysisDefinition[]
splice(start: number, deleteCount: number, ...items: AnalysisDefinition[]): AnalysisDefinition[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns AnalysisDefinition[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: AnalysisDefinition[]
  
  Elements to insert into the array in place of the deleted elements.
Returns AnalysisDefinition[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: AnalysisDefinition[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: AnalysisDefinition[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<AnalysisDefinition>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<AnalysisDefinition>

type

type: object

className

className: string = "DiagnosticAnalysisCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "AnalysisDefinition"

name

Const DiagnosticCategory

DiagnosticCategory: object

interface: An interface representing DiagnosticCategory. Class representing detector definition
extends: ProxyOnlyResource

Optional description

description: undefined | string

member: {string} [description] Description of the diagnostic category NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DiagnosticCategory"

type

type: object

className

className: string = "DiagnosticCategory"

name

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

Const DiagnosticCategoryCollection

DiagnosticCategoryCollection: object

interface: An interface representing the DiagnosticCategoryCollection. Collection of Diagnostic Categories
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DiagnosticCategoryCollection"

__@iterator

__@iterator(): IterableIterator<DiagnosticCategory>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<DiagnosticCategory>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<DiagnosticCategory>[]): DiagnosticCategory[]
concat(...items: (T | ConcatArray<T>)[]): DiagnosticCategory[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<DiagnosticCategory>[]
 
 Additional items to add to the end of array1.
Returns DiagnosticCategory[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns DiagnosticCategory[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, DiagnosticCategory]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, DiagnosticCategory]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: DiagnosticCategory, index: number, array: DiagnosticCategory[]): boolean
    - Parameters
      - value: DiagnosticCategory
      - index: number
      - array: DiagnosticCategory[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: DiagnosticCategory, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: DiagnosticCategory
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): DiagnosticCategory[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: DiagnosticCategory
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: DiagnosticCategory, index: number, array: DiagnosticCategory[]): boolean
    - Parameters
      - value: DiagnosticCategory
      - index: number
      - array: DiagnosticCategory[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: DiagnosticCategory, index: number, array: DiagnosticCategory[]): any
    - Parameters
      - value: DiagnosticCategory
      - index: number
      - array: DiagnosticCategory[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns DiagnosticCategory[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): DiagnosticCategory | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: DiagnosticCategory
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: DiagnosticCategory, index: number, obj: DiagnosticCategory[]): boolean
    - Parameters
      - this: void
      - value: DiagnosticCategory
      - index: number
      - obj: DiagnosticCategory[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: DiagnosticCategory, index: number, obj: DiagnosticCategory[]): boolean
    - Parameters
      - value: DiagnosticCategory
      - index: number
      - obj: DiagnosticCategory[]
      Returns boolean
- Optional thisArg: any
Returns DiagnosticCategory | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: DiagnosticCategory, index: number, obj: DiagnosticCategory[]): boolean
    - Parameters
      - value: DiagnosticCategory
      - index: number
      - obj: DiagnosticCategory[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: DiagnosticCategory, index: number, array: DiagnosticCategory[]): void
    - Parameters
      - value: DiagnosticCategory
      - index: number
      - array: DiagnosticCategory[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: DiagnosticCategory, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: DiagnosticCategory
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: DiagnosticCategory, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: DiagnosticCategory
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: DiagnosticCategory, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: DiagnosticCategory
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: DiagnosticCategory, index: number, array: DiagnosticCategory[]): U
    - Parameters
      - value: DiagnosticCategory
      - index: number
      - array: DiagnosticCategory[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): DiagnosticCategory | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns DiagnosticCategory | undefined

push

push(...items: DiagnosticCategory[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: DiagnosticCategory[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): DiagnosticCategory
reduce(callbackfn: function, initialValue: DiagnosticCategory): DiagnosticCategory
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: DiagnosticCategory, currentValue: DiagnosticCategory, currentIndex: number, array: DiagnosticCategory[]): DiagnosticCategory
    - Parameters
      - previousValue: DiagnosticCategory
      - currentValue: DiagnosticCategory
      - currentIndex: number
      - array: DiagnosticCategory[]
      Returns DiagnosticCategory
Returns DiagnosticCategory
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: DiagnosticCategory, currentValue: DiagnosticCategory, currentIndex: number, array: DiagnosticCategory[]): DiagnosticCategory
    - Parameters
      - previousValue: DiagnosticCategory
      - currentValue: DiagnosticCategory
      - currentIndex: number
      - array: DiagnosticCategory[]
      Returns DiagnosticCategory
- initialValue: DiagnosticCategory
Returns DiagnosticCategory
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: DiagnosticCategory, currentIndex: number, array: DiagnosticCategory[]): U
    - Parameters
      - previousValue: U
      - currentValue: DiagnosticCategory
      - currentIndex: number
      - array: DiagnosticCategory[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): DiagnosticCategory
reduceRight(callbackfn: function, initialValue: DiagnosticCategory): DiagnosticCategory
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: DiagnosticCategory, currentValue: DiagnosticCategory, currentIndex: number, array: DiagnosticCategory[]): DiagnosticCategory
    - Parameters
      - previousValue: DiagnosticCategory
      - currentValue: DiagnosticCategory
      - currentIndex: number
      - array: DiagnosticCategory[]
      Returns DiagnosticCategory
Returns DiagnosticCategory
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: DiagnosticCategory, currentValue: DiagnosticCategory, currentIndex: number, array: DiagnosticCategory[]): DiagnosticCategory
    - Parameters
      - previousValue: DiagnosticCategory
      - currentValue: DiagnosticCategory
      - currentIndex: number
      - array: DiagnosticCategory[]
      Returns DiagnosticCategory
- initialValue: DiagnosticCategory
Returns DiagnosticCategory
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: DiagnosticCategory, currentIndex: number, array: DiagnosticCategory[]): U
    - Parameters
      - previousValue: U
      - currentValue: DiagnosticCategory
      - currentIndex: number
      - array: DiagnosticCategory[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): DiagnosticCategory[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns DiagnosticCategory[]

shift

shift(): DiagnosticCategory | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns DiagnosticCategory | undefined

slice

slice(start?: undefined | number, end?: undefined | number): DiagnosticCategory[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns DiagnosticCategory[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: DiagnosticCategory, index: number, array: DiagnosticCategory[]): boolean
    - Parameters
      - value: DiagnosticCategory
      - index: number
      - array: DiagnosticCategory[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): DiagnosticCategory[]
splice(start: number, deleteCount: number, ...items: DiagnosticCategory[]): DiagnosticCategory[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns DiagnosticCategory[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: DiagnosticCategory[]
  
  Elements to insert into the array in place of the deleted elements.
Returns DiagnosticCategory[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: DiagnosticCategory[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: DiagnosticCategory[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<DiagnosticCategory>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<DiagnosticCategory>

type

type: object

className

className: string = "DiagnosticCategoryCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "DiagnosticCategory"

name

Const DiagnosticData

DiagnosticData: object

interface: An interface representing DiagnosticData. Set of data with rendering instructions

Optional renderingProperties

renderingProperties: Rendering

member: {Rendering} [renderingProperties] Properties that describe how the table should be rendered

serializedName

serializedName: string = "DiagnosticData"

Optional table

table: DataTableResponseObject

member: {DataTableResponseObject} [table] Data in table form

type

type: object

className

className: string = "DiagnosticData"

name

modelProperties

modelProperties: object

renderingProperties

renderingProperties: object

serializedName

serializedName: string = "renderingProperties"

type

type: object

className

className: string = "Rendering"

name

table

table: object

serializedName

serializedName: string = "table"

type

type: object

className

className: string = "DataTableResponseObject"

name

Const DiagnosticDetectorCollection

DiagnosticDetectorCollection: object

interface: An interface representing the DiagnosticDetectorCollection. Collection of Diagnostic Detectors
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DiagnosticDetectorCollection"

__@iterator

__@iterator(): IterableIterator<DetectorDefinition>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<DetectorDefinition>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<DetectorDefinition>[]): DetectorDefinition[]
concat(...items: (T | ConcatArray<T>)[]): DetectorDefinition[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<DetectorDefinition>[]
 
 Additional items to add to the end of array1.
Returns DetectorDefinition[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns DetectorDefinition[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, DetectorDefinition]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, DetectorDefinition]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: DetectorDefinition, index: number, array: DetectorDefinition[]): boolean
    - Parameters
      - value: DetectorDefinition
      - index: number
      - array: DetectorDefinition[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: DetectorDefinition, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: DetectorDefinition
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): DetectorDefinition[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: DetectorDefinition
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: DetectorDefinition, index: number, array: DetectorDefinition[]): boolean
    - Parameters
      - value: DetectorDefinition
      - index: number
      - array: DetectorDefinition[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: DetectorDefinition, index: number, array: DetectorDefinition[]): any
    - Parameters
      - value: DetectorDefinition
      - index: number
      - array: DetectorDefinition[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns DetectorDefinition[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): DetectorDefinition | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: DetectorDefinition
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: DetectorDefinition, index: number, obj: DetectorDefinition[]): boolean
    - Parameters
      - this: void
      - value: DetectorDefinition
      - index: number
      - obj: DetectorDefinition[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: DetectorDefinition, index: number, obj: DetectorDefinition[]): boolean
    - Parameters
      - value: DetectorDefinition
      - index: number
      - obj: DetectorDefinition[]
      Returns boolean
- Optional thisArg: any
Returns DetectorDefinition | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: DetectorDefinition, index: number, obj: DetectorDefinition[]): boolean
    - Parameters
      - value: DetectorDefinition
      - index: number
      - obj: DetectorDefinition[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: DetectorDefinition, index: number, array: DetectorDefinition[]): void
    - Parameters
      - value: DetectorDefinition
      - index: number
      - array: DetectorDefinition[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: DetectorDefinition, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: DetectorDefinition
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: DetectorDefinition, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: DetectorDefinition
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: DetectorDefinition, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: DetectorDefinition
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: DetectorDefinition, index: number, array: DetectorDefinition[]): U
    - Parameters
      - value: DetectorDefinition
      - index: number
      - array: DetectorDefinition[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): DetectorDefinition | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns DetectorDefinition | undefined

push

push(...items: DetectorDefinition[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: DetectorDefinition[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): DetectorDefinition
reduce(callbackfn: function, initialValue: DetectorDefinition): DetectorDefinition
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: DetectorDefinition, currentValue: DetectorDefinition, currentIndex: number, array: DetectorDefinition[]): DetectorDefinition
    - Parameters
      - previousValue: DetectorDefinition
      - currentValue: DetectorDefinition
      - currentIndex: number
      - array: DetectorDefinition[]
      Returns DetectorDefinition
Returns DetectorDefinition
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: DetectorDefinition, currentValue: DetectorDefinition, currentIndex: number, array: DetectorDefinition[]): DetectorDefinition
    - Parameters
      - previousValue: DetectorDefinition
      - currentValue: DetectorDefinition
      - currentIndex: number
      - array: DetectorDefinition[]
      Returns DetectorDefinition
- initialValue: DetectorDefinition
Returns DetectorDefinition
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: DetectorDefinition, currentIndex: number, array: DetectorDefinition[]): U
    - Parameters
      - previousValue: U
      - currentValue: DetectorDefinition
      - currentIndex: number
      - array: DetectorDefinition[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): DetectorDefinition
reduceRight(callbackfn: function, initialValue: DetectorDefinition): DetectorDefinition
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: DetectorDefinition, currentValue: DetectorDefinition, currentIndex: number, array: DetectorDefinition[]): DetectorDefinition
    - Parameters
      - previousValue: DetectorDefinition
      - currentValue: DetectorDefinition
      - currentIndex: number
      - array: DetectorDefinition[]
      Returns DetectorDefinition
Returns DetectorDefinition
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: DetectorDefinition, currentValue: DetectorDefinition, currentIndex: number, array: DetectorDefinition[]): DetectorDefinition
    - Parameters
      - previousValue: DetectorDefinition
      - currentValue: DetectorDefinition
      - currentIndex: number
      - array: DetectorDefinition[]
      Returns DetectorDefinition
- initialValue: DetectorDefinition
Returns DetectorDefinition
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: DetectorDefinition, currentIndex: number, array: DetectorDefinition[]): U
    - Parameters
      - previousValue: U
      - currentValue: DetectorDefinition
      - currentIndex: number
      - array: DetectorDefinition[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): DetectorDefinition[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns DetectorDefinition[]

shift

shift(): DetectorDefinition | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns DetectorDefinition | undefined

slice

slice(start?: undefined | number, end?: undefined | number): DetectorDefinition[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns DetectorDefinition[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: DetectorDefinition, index: number, array: DetectorDefinition[]): boolean
    - Parameters
      - value: DetectorDefinition
      - index: number
      - array: DetectorDefinition[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): DetectorDefinition[]
splice(start: number, deleteCount: number, ...items: DetectorDefinition[]): DetectorDefinition[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns DetectorDefinition[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: DetectorDefinition[]
  
  Elements to insert into the array in place of the deleted elements.
Returns DetectorDefinition[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: DetectorDefinition[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: DetectorDefinition[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<DetectorDefinition>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<DetectorDefinition>

type

type: object

className

className: string = "DiagnosticDetectorCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "DetectorDefinition"

name

Const DiagnosticDetectorResponse

DiagnosticDetectorResponse: object

interface: An interface representing DiagnosticDetectorResponse. Class representing Reponse from Diagnostic Detectors
extends: ProxyOnlyResource

Optional abnormalTimePeriods

abnormalTimePeriods: DetectorAbnormalTimePeriod[]

member: {DetectorAbnormalTimePeriod[]} [abnormalTimePeriods] List of Correlated events found by the detector

Optional data

data: NameValuePair[][]

member: {NameValuePair[][]} [data] Additional Data that detector wants to send.

Optional detectorDefinition

detectorDefinition: DetectorDefinition

member: {DetectorDefinition} [detectorDefinition] Detector's definition

Optional endTime

endTime: Date

member: {Date} [endTime] End time of the period

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issueDetected

issueDetected: undefined | false | true

member: {boolean} [issueDetected] Flag representing Issue was detected.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional metrics

metrics: DiagnosticMetricSet[]

member: {DiagnosticMetricSet[]} [metrics] Metrics provided by the detector

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional responseMetaData

responseMetaData: ResponseMetaData

member: {ResponseMetaData} [responseMetaData] Meta Data

serializedName

serializedName: string = "DiagnosticDetectorResponse"

Optional startTime

startTime: Date

member: {Date} [startTime] Start time of the period

type

type: object

className

className: string = "DiagnosticDetectorResponse"

name

modelProperties

className

className: string = "NameValuePair"

name

detectorDefinition

className

className: string = "ResponseMetaData"

name

startTime

startTime: object

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

Const DiagnosticMetricSample

DiagnosticMetricSample: object

interface: An interface representing DiagnosticMetricSample. Class representing Diagnostic Metric

Optional isAggregated

isAggregated: undefined | false | true

member: {boolean} [isAggregated] Whether the values are aggregates across all workers or not

Optional maximum

maximum: undefined | number

member: {number} [maximum] Maximum of the metric sampled during the time period

Optional minimum

minimum: undefined | number

member: {number} [minimum] Minimum of the metric sampled during the time period

Optional roleInstance

roleInstance: undefined | string

member: {string} [roleInstance] Role Instance. Null if this counter is not per instance This is returned and should be whichever instance name we desire to be returned i.e. CPU and Memory return RDWORKERNAME (LargeDed...IN0) where RDWORKERNAME is Machine name below and RoleInstance name in parenthesis

serializedName

serializedName: string = "DiagnosticMetricSample"

Optional timestamp

timestamp: Date

member: {Date} [timestamp] Time at which metric is measured

Optional total

total: undefined | number

member: {number} [total] Total value of the metric. If multiple measurements are made this will have sum of all.

type

type: object

className

className: string = "DiagnosticMetricSample"

name

modelProperties

name

Const DiagnosticMetricSet

DiagnosticMetricSet: object

interface: An interface representing DiagnosticMetricSet. Class representing Diagnostic Metric information

Optional endTime

endTime: Date

member: {Date} [endTime] End time of the period

Optional name

member: {string} [name] Name of the metric

serializedName

serializedName: string = "DiagnosticMetricSet"

Optional startTime

startTime: Date

member: {Date} [startTime] Start time of the period

Optional timeGrain

timeGrain: undefined | string

member: {string} [timeGrain] Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D

Optional unit

unit: undefined | string

member: {string} [unit] Metric's unit

Optional values

values: DiagnosticMetricSample[]

member: {DiagnosticMetricSample[]} [values] Collection of metric values for the selected period based on the {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain}

type

type: object

className

className: string = "DiagnosticMetricSet"

name

modelProperties

modelProperties: object

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

Const Dimension

Dimension: object

interface: An interface representing Dimension. Dimension of a resource metric. For e.g. instance specific HTTP requests for a web app, where instance name is dimension of the metric HTTP request

Optional displayName

displayName: undefined | string

member: {string} [displayName]

Optional internalName

internalName: undefined | string

member: {string} [internalName]

Optional name

member: {string} [name]

serializedName

serializedName: string = "Dimension"

Optional toBeExportedForShoebox

toBeExportedForShoebox: undefined | false | true

member: {boolean} [toBeExportedForShoebox]

type

type: object

className

className: string = "Dimension"

name

modelProperties

modelProperties: object

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

internalName

internalName: object

serializedName

serializedName: string = "internalName"

type

type: object

name

name

serializedName

serializedName: string = "name"

type

type: object

name

toBeExportedForShoebox

toBeExportedForShoebox: object

serializedName

serializedName: string = "toBeExportedForShoebox"

type

type: object

name

Const Domain

Domain: object

interface: An interface representing Domain. Information about a domain.
extends: Resource

Optional authCode

authCode: undefined | string

member: {string} [authCode]

Optional autoRenew

autoRenew: undefined | false | true

member: {boolean} [autoRenew] true if the domain should be automatically renewed; otherwise, false. Default value: true .

consent

consent: DomainPurchaseConsent

member: {DomainPurchaseConsent} consent Legal agreement consent.

contactAdmin

contactAdmin: Contact

member: {Contact} contactAdmin Administrative contact.

contactBilling

contactBilling: Contact

member: {Contact} contactBilling Billing contact.

contactRegistrant

contactRegistrant: Contact

member: {Contact} contactRegistrant Registrant contact.

contactTech

contactTech: Contact

member: {Contact} contactTech Technical contact.

Optional createdTime

createdTime: Date

member: {Date} [createdTime] Domain creation timestamp. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dnsType

dnsType: DnsType

member: {DnsType} [dnsType] Current DNS type. Possible values include: 'AzureDns', 'DefaultDomainRegistrarDns'

Optional dnsZoneId

dnsZoneId: undefined | string

member: {string} [dnsZoneId] Azure DNS Zone to use

Optional domainNotRenewableReasons

domainNotRenewableReasons: string[]

member: {string[]} [domainNotRenewableReasons] Reasons why domain is not renewable. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expirationTime

expirationTime: Date

member: {Date} [expirationTime] Domain expiration timestamp. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional lastRenewedTime

lastRenewedTime: Date

member: {Date} [lastRenewedTime] Timestamp when the domain was renewed last time. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

member: {string} location Resource Location.

Optional managedHostNames

managedHostNames: HostName[]

member: {HostName[]} [managedHostNames] All hostnames derived from the domain and assigned to Azure resources. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nameServers

nameServers: string[]

member: {string[]} [nameServers] Name servers. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privacy

privacy: undefined | false | true

member: {boolean} [privacy] true if domain privacy is enabled for this domain; otherwise, false.

Optional provisioningState

provisioningState: ProvisioningState

member: {ProvisioningState} [provisioningState] Domain provisioning state. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional readyForDnsRecordManagement

readyForDnsRecordManagement: undefined | false | true

member: {boolean} [readyForDnsRecordManagement] true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional registrationStatus

registrationStatus: DomainStatus

member: {DomainStatus} [registrationStatus] Domain registration status. Possible values include: 'Active', 'Awaiting', 'Cancelled', 'Confiscated', 'Disabled', 'Excluded', 'Expired', 'Failed', 'Held', 'Locked', 'Parked', 'Pending', 'Reserved', 'Reverted', 'Suspended', 'Transferred', 'Unknown', 'Unlocked', 'Unparked', 'Updated', 'JsonConverterFailed' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Domain"

Optional tags

tags: undefined | object

member: {{ [propertyName: string]: string }} [tags] Resource tags.

Optional targetDnsType

targetDnsType: DnsType

member: {DnsType} [targetDnsType] Target DNS type (would be used for migration). Possible values include: 'AzureDns', 'DefaultDomainRegistrarDns'

type

type: object

className

className: string = "Domain"

name

modelProperties

modelProperties: object

authCode

authCode: object

serializedName

serializedName: string = "properties.authCode"

type

type: object

createdTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdTime"

type

type: object

name

dnsType

dnsType: object

serializedName

name

lastRenewedTime

lastRenewedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastRenewedTime"

type

type: object

name

managedHostNames

managedHostNames: object

readOnly

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

name

readyForDnsRecordManagement

readyForDnsRecordManagement: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.readyForDnsRecordManagement"

type

type: object

name

registrationStatus

registrationStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.registrationStatus"

type

type: object

allowedValues

allowedValues: string[] = ["Active","Awaiting","Cancelled","Confiscated","Disabled","Excluded","Expired","Failed","Held","Locked","Parked","Pending","Reserved","Reverted","Suspended","Transferred","Unknown","Unlocked","Unparked","Updated","JsonConverterFailed"]

name

targetDnsType

targetDnsType: object

serializedName

serializedName: string = "properties.targetDnsType"

type

type: object

allowedValues

allowedValues: string[] = ["AzureDns","DefaultDomainRegistrarDns"]

name

Const DomainAvailablilityCheckResult

DomainAvailablilityCheckResult: object

interface: An interface representing DomainAvailablilityCheckResult. Domain availablility check result.

Optional available

available: undefined | false | true

member: {boolean} [available] true if domain can be purchased using CreateDomain API; otherwise, false.

Optional domainType

domainType: DomainType

member: {DomainType} [domainType] Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything. Possible values include: 'Regular', 'SoftDeleted'

Optional name

member: {string} [name] Name of the domain.

serializedName: string = "name"

type

type: object

name

Const DomainCollection

DomainCollection: object

interface: An interface representing the DomainCollection. Collection of domains.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DomainCollection"

__@iterator

__@iterator(): IterableIterator<Domain>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<Domain>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<Domain>[]): Domain[]
concat(...items: (T | ConcatArray<T>)[]): Domain[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<Domain>[]
 
 Additional items to add to the end of array1.
Returns Domain[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns Domain[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, Domain]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, Domain]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: Domain, index: number, array: Domain[]): boolean
    - Parameters
      - value: Domain
      - index: number
      - array: Domain[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: Domain, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: Domain
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): Domain[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: Domain
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Domain, index: number, array: Domain[]): boolean
    - Parameters
      - value: Domain
      - index: number
      - array: Domain[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Domain, index: number, array: Domain[]): any
    - Parameters
      - value: Domain
      - index: number
      - array: Domain[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Domain[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): Domain | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: Domain
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: Domain, index: number, obj: Domain[]): boolean
    - Parameters
      - this: void
      - value: Domain
      - index: number
      - obj: Domain[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: Domain, index: number, obj: Domain[]): boolean
    - Parameters
      - value: Domain
      - index: number
      - obj: Domain[]
      Returns boolean
- Optional thisArg: any
Returns Domain | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: Domain, index: number, obj: Domain[]): boolean
    - Parameters
      - value: Domain
      - index: number
      - obj: Domain[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: Domain, index: number, array: Domain[]): void
    - Parameters
      - value: Domain
      - index: number
      - array: Domain[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: Domain, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: Domain
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: Domain, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: Domain
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: Domain, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: Domain
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: Domain, index: number, array: Domain[]): U
    - Parameters
      - value: Domain
      - index: number
      - array: Domain[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): Domain | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns Domain | undefined

push

push(...items: Domain[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: Domain[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): Domain
reduce(callbackfn: function, initialValue: Domain): Domain
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Domain, currentValue: Domain, currentIndex: number, array: Domain[]): Domain
    - Parameters
      - previousValue: Domain
      - currentValue: Domain
      - currentIndex: number
      - array: Domain[]
      Returns Domain
Returns Domain
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: Domain, currentValue: Domain, currentIndex: number, array: Domain[]): Domain
    - Parameters
      - previousValue: Domain
      - currentValue: Domain
      - currentIndex: number
      - array: Domain[]
      Returns Domain
- initialValue: Domain
Returns Domain
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Domain, currentIndex: number, array: Domain[]): U
    - Parameters
      - previousValue: U
      - currentValue: Domain
      - currentIndex: number
      - array: Domain[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): Domain
reduceRight(callbackfn: function, initialValue: Domain): Domain
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Domain, currentValue: Domain, currentIndex: number, array: Domain[]): Domain
    - Parameters
      - previousValue: Domain
      - currentValue: Domain
      - currentIndex: number
      - array: Domain[]
      Returns Domain
Returns Domain
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: Domain, currentValue: Domain, currentIndex: number, array: Domain[]): Domain
    - Parameters
      - previousValue: Domain
      - currentValue: Domain
      - currentIndex: number
      - array: Domain[]
      Returns Domain
- initialValue: Domain
Returns Domain
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Domain, currentIndex: number, array: Domain[]): U
    - Parameters
      - previousValue: U
      - currentValue: Domain
      - currentIndex: number
      - array: Domain[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): Domain[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns Domain[]

shift

shift(): Domain | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns Domain | undefined

slice

slice(start?: undefined | number, end?: undefined | number): Domain[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns Domain[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: Domain, index: number, array: Domain[]): boolean
    - Parameters
      - value: Domain
      - index: number
      - array: Domain[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): Domain[]
splice(start: number, deleteCount: number, ...items: Domain[]): Domain[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns Domain[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: Domain[]
  
  Elements to insert into the array in place of the deleted elements.
Returns Domain[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: Domain[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: Domain[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<Domain>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<Domain>

type

type: object

className

className: string = "DomainCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "Domain"

name

Const DomainControlCenterSsoRequest

DomainControlCenterSsoRequest: object

interface: An interface representing DomainControlCenterSsoRequest. Single sign-on request information for domain management.

Optional postParameterKey

postParameterKey: undefined | string

member: {string} [postParameterKey] Post parameter key. NOTE: This property will not be serialized. It can only be populated by the server.

Optional postParameterValue

postParameterValue: undefined | string

member: {string} [postParameterValue] Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DomainControlCenterSsoRequest"

Optional url

url: undefined | string

member: {string} [url] URL where the single sign-on request is to be made. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "DomainControlCenterSsoRequest"

name

modelProperties

name

Const DomainOwnershipIdentifier

DomainOwnershipIdentifier: object

interface: An interface representing DomainOwnershipIdentifier. Domain ownership Identifier.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ownershipId

ownershipId: undefined | string

member: {string} [ownershipId] Ownership Id.

serializedName

serializedName: string = "DomainOwnershipIdentifier"

type

type: object

className

className: string = "DomainOwnershipIdentifier"

name

modelProperties

modelProperties: object

ownershipId

ownershipId: object

serializedName

serializedName: string = "properties.ownershipId"

type

type: object

name

Const DomainOwnershipIdentifierCollection

DomainOwnershipIdentifierCollection: object

interface: An interface representing the DomainOwnershipIdentifierCollection. Collection of domain ownership identifiers.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DomainOwnershipIdentifierCollection"

__@iterator

__@iterator(): IterableIterator<DomainOwnershipIdentifier>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<DomainOwnershipIdentifier>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<DomainOwnershipIdentifier>[]): DomainOwnershipIdentifier[]
concat(...items: (T | ConcatArray<T>)[]): DomainOwnershipIdentifier[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<DomainOwnershipIdentifier>[]
 
 Additional items to add to the end of array1.
Returns DomainOwnershipIdentifier[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns DomainOwnershipIdentifier[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, DomainOwnershipIdentifier]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, DomainOwnershipIdentifier]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: DomainOwnershipIdentifier, index: number, array: DomainOwnershipIdentifier[]): boolean
    - Parameters
      - value: DomainOwnershipIdentifier
      - index: number
      - array: DomainOwnershipIdentifier[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: DomainOwnershipIdentifier, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: DomainOwnershipIdentifier
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): DomainOwnershipIdentifier[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: DomainOwnershipIdentifier
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: DomainOwnershipIdentifier, index: number, array: DomainOwnershipIdentifier[]): boolean
    - Parameters
      - value: DomainOwnershipIdentifier
      - index: number
      - array: DomainOwnershipIdentifier[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: DomainOwnershipIdentifier, index: number, array: DomainOwnershipIdentifier[]): any
    - Parameters
      - value: DomainOwnershipIdentifier
      - index: number
      - array: DomainOwnershipIdentifier[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns DomainOwnershipIdentifier[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): DomainOwnershipIdentifier | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: DomainOwnershipIdentifier
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: DomainOwnershipIdentifier, index: number, obj: DomainOwnershipIdentifier[]): boolean
    - Parameters
      - this: void
      - value: DomainOwnershipIdentifier
      - index: number
      - obj: DomainOwnershipIdentifier[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: DomainOwnershipIdentifier, index: number, obj: DomainOwnershipIdentifier[]): boolean
    - Parameters
      - value: DomainOwnershipIdentifier
      - index: number
      - obj: DomainOwnershipIdentifier[]
      Returns boolean
- Optional thisArg: any
Returns DomainOwnershipIdentifier | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: DomainOwnershipIdentifier, index: number, obj: DomainOwnershipIdentifier[]): boolean
    - Parameters
      - value: DomainOwnershipIdentifier
      - index: number
      - obj: DomainOwnershipIdentifier[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: DomainOwnershipIdentifier, index: number, array: DomainOwnershipIdentifier[]): void
    - Parameters
      - value: DomainOwnershipIdentifier
      - index: number
      - array: DomainOwnershipIdentifier[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: DomainOwnershipIdentifier, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: DomainOwnershipIdentifier
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: DomainOwnershipIdentifier, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: DomainOwnershipIdentifier
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: DomainOwnershipIdentifier, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: DomainOwnershipIdentifier
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: DomainOwnershipIdentifier, index: number, array: DomainOwnershipIdentifier[]): U
    - Parameters
      - value: DomainOwnershipIdentifier
      - index: number
      - array: DomainOwnershipIdentifier[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): DomainOwnershipIdentifier | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns DomainOwnershipIdentifier | undefined

push

push(...items: DomainOwnershipIdentifier[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: DomainOwnershipIdentifier[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): DomainOwnershipIdentifier
reduce(callbackfn: function, initialValue: DomainOwnershipIdentifier): DomainOwnershipIdentifier
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: DomainOwnershipIdentifier, currentValue: DomainOwnershipIdentifier, currentIndex: number, array: DomainOwnershipIdentifier[]): DomainOwnershipIdentifier
    - Parameters
      - previousValue: DomainOwnershipIdentifier
      - currentValue: DomainOwnershipIdentifier
      - currentIndex: number
      - array: DomainOwnershipIdentifier[]
      Returns DomainOwnershipIdentifier
Returns DomainOwnershipIdentifier
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: DomainOwnershipIdentifier, currentValue: DomainOwnershipIdentifier, currentIndex: number, array: DomainOwnershipIdentifier[]): DomainOwnershipIdentifier
    - Parameters
      - previousValue: DomainOwnershipIdentifier
      - currentValue: DomainOwnershipIdentifier
      - currentIndex: number
      - array: DomainOwnershipIdentifier[]
      Returns DomainOwnershipIdentifier
- initialValue: DomainOwnershipIdentifier
Returns DomainOwnershipIdentifier
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: DomainOwnershipIdentifier, currentIndex: number, array: DomainOwnershipIdentifier[]): U
    - Parameters
      - previousValue: U
      - currentValue: DomainOwnershipIdentifier
      - currentIndex: number
      - array: DomainOwnershipIdentifier[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): DomainOwnershipIdentifier
reduceRight(callbackfn: function, initialValue: DomainOwnershipIdentifier): DomainOwnershipIdentifier
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: DomainOwnershipIdentifier, currentValue: DomainOwnershipIdentifier, currentIndex: number, array: DomainOwnershipIdentifier[]): DomainOwnershipIdentifier
    - Parameters
      - previousValue: DomainOwnershipIdentifier
      - currentValue: DomainOwnershipIdentifier
      - currentIndex: number
      - array: DomainOwnershipIdentifier[]
      Returns DomainOwnershipIdentifier
Returns DomainOwnershipIdentifier
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: DomainOwnershipIdentifier, currentValue: DomainOwnershipIdentifier, currentIndex: number, array: DomainOwnershipIdentifier[]): DomainOwnershipIdentifier
    - Parameters
      - previousValue: DomainOwnershipIdentifier
      - currentValue: DomainOwnershipIdentifier
      - currentIndex: number
      - array: DomainOwnershipIdentifier[]
      Returns DomainOwnershipIdentifier
- initialValue: DomainOwnershipIdentifier
Returns DomainOwnershipIdentifier
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: DomainOwnershipIdentifier, currentIndex: number, array: DomainOwnershipIdentifier[]): U
    - Parameters
      - previousValue: U
      - currentValue: DomainOwnershipIdentifier
      - currentIndex: number
      - array: DomainOwnershipIdentifier[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): DomainOwnershipIdentifier[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns DomainOwnershipIdentifier[]

shift

shift(): DomainOwnershipIdentifier | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns DomainOwnershipIdentifier | undefined

slice

slice(start?: undefined | number, end?: undefined | number): DomainOwnershipIdentifier[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns DomainOwnershipIdentifier[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: DomainOwnershipIdentifier, index: number, array: DomainOwnershipIdentifier[]): boolean
    - Parameters
      - value: DomainOwnershipIdentifier
      - index: number
      - array: DomainOwnershipIdentifier[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): DomainOwnershipIdentifier[]
splice(start: number, deleteCount: number, ...items: DomainOwnershipIdentifier[]): DomainOwnershipIdentifier[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns DomainOwnershipIdentifier[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: DomainOwnershipIdentifier[]
  
  Elements to insert into the array in place of the deleted elements.
Returns DomainOwnershipIdentifier[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: DomainOwnershipIdentifier[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: DomainOwnershipIdentifier[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<DomainOwnershipIdentifier>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<DomainOwnershipIdentifier>

type

type: object

className

className: string = "DomainOwnershipIdentifierCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "DomainOwnershipIdentifier"

name

Const DomainPatchResource

DomainPatchResource: object

interface: An interface representing DomainPatchResource. ARM resource for a domain.
extends: ProxyOnlyResource

Optional authCode

authCode: undefined | string

member: {string} [authCode]

Optional autoRenew

autoRenew: undefined | false | true

member: {boolean} [autoRenew] true if the domain should be automatically renewed; otherwise, false. Default value: true .

consent

consent: DomainPurchaseConsent

member: {DomainPurchaseConsent} consent Legal agreement consent.

contactAdmin

contactAdmin: Contact

member: {Contact} contactAdmin Administrative contact.

contactBilling

contactBilling: Contact

member: {Contact} contactBilling Billing contact.

contactRegistrant

contactRegistrant: Contact

member: {Contact} contactRegistrant Registrant contact.

contactTech

contactTech: Contact

member: {Contact} contactTech Technical contact.

Optional createdTime

createdTime: Date

member: {Date} [createdTime] Domain creation timestamp. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dnsType

dnsType: DnsType

member: {DnsType} [dnsType] Current DNS type. Possible values include: 'AzureDns', 'DefaultDomainRegistrarDns'

Optional dnsZoneId

dnsZoneId: undefined | string

member: {string} [dnsZoneId] Azure DNS Zone to use

Optional domainNotRenewableReasons

domainNotRenewableReasons: string[]

member: {string[]} [domainNotRenewableReasons] Reasons why domain is not renewable. NOTE: This property will not be serialized. It can only be populated by the server.

Optional expirationTime

expirationTime: Date

member: {Date} [expirationTime] Domain expiration timestamp. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional lastRenewedTime

lastRenewedTime: Date

member: {Date} [lastRenewedTime] Timestamp when the domain was renewed last time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional managedHostNames

managedHostNames: HostName[]

member: {HostName[]} [managedHostNames] All hostnames derived from the domain and assigned to Azure resources. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nameServers

nameServers: string[]

member: {string[]} [nameServers] Name servers. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privacy

privacy: undefined | false | true

member: {boolean} [privacy] true if domain privacy is enabled for this domain; otherwise, false.

Optional provisioningState

provisioningState: ProvisioningState

member: {ProvisioningState} [provisioningState] Domain provisioning state. Possible values include: 'Succeeded', 'Failed', 'Canceled', 'InProgress', 'Deleting' NOTE: This property will not be serialized. It can only be populated by the server.

Optional readyForDnsRecordManagement

readyForDnsRecordManagement: undefined | false | true

member: {boolean} [readyForDnsRecordManagement] true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and it is hosted on name servers Azure has programmatic access to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional registrationStatus

registrationStatus: DomainStatus

member: {DomainStatus} [registrationStatus] Domain registration status. Possible values include: 'Active', 'Awaiting', 'Cancelled', 'Confiscated', 'Disabled', 'Excluded', 'Expired', 'Failed', 'Held', 'Locked', 'Parked', 'Pending', 'Reserved', 'Reverted', 'Suspended', 'Transferred', 'Unknown', 'Unlocked', 'Unparked', 'Updated', 'JsonConverterFailed' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "DomainPatchResource"

Optional targetDnsType

targetDnsType: DnsType

member: {DnsType} [targetDnsType] Target DNS type (would be used for migration). Possible values include: 'AzureDns', 'DefaultDomainRegistrarDns'

type

type: object

className

className: string = "DomainPatchResource"

name

modelProperties

modelProperties: object

authCode

authCode: object

serializedName

serializedName: string = "properties.authCode"

type

type: object

createdTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdTime"

type

type: object

name

dnsType

dnsType: object

serializedName

name

lastRenewedTime

lastRenewedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastRenewedTime"

type

type: object

name

managedHostNames

managedHostNames: object

readOnly

allowedValues

allowedValues: string[] = ["Succeeded","Failed","Canceled","InProgress","Deleting"]

name

readyForDnsRecordManagement

readyForDnsRecordManagement: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.readyForDnsRecordManagement"

type

type: object

name

registrationStatus

registrationStatus: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.registrationStatus"

type

type: object

allowedValues

name

targetDnsType

targetDnsType: object

serializedName

serializedName: string = "properties.targetDnsType"

type

type: object

allowedValues

allowedValues: string[] = ["AzureDns","DefaultDomainRegistrarDns"]

name

Const DomainPurchaseConsent

DomainPurchaseConsent: object

interface: An interface representing DomainPurchaseConsent. Domain purchase consent object, representing acceptance of applicable legal agreements.

Optional agreedAt

agreedAt: Date

member: {Date} [agreedAt] Timestamp when the agreements were accepted.

Optional agreedBy

agreedBy: undefined | string

member: {string} [agreedBy] Client IP address.

Optional agreementKeys

agreementKeys: string[]

member: {string[]} [agreementKeys] List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.

serializedName

serializedName: string = "DomainPurchaseConsent"

type

type: object

className

className: string = "DomainPurchaseConsent"

name

modelProperties

name

element

element: object

type

type: object

name

Const DomainRecommendationSearchParameters

DomainRecommendationSearchParameters: object

interface: An interface representing DomainRecommendationSearchParameters. Domain recommendation search parameters.

Optional keywords

keywords: undefined | string

member: {string} [keywords] Keywords to be used for generating domain recommendations.

Optional maxDomainRecommendations

maxDomainRecommendations: undefined | number

member: {number} [maxDomainRecommendations] Maximum number of recommendations.

serializedName

serializedName: string = "DomainRecommendationSearchParameters"

type

type: object

className

className: string = "DomainRecommendationSearchParameters"

name

modelProperties

modelProperties: object

keywords

keywords: object

serializedName

serializedName: string = "keywords"

type

type: object

name

maxDomainRecommendations

maxDomainRecommendations: object

serializedName

serializedName: string = "maxDomainRecommendations"

type

type: object

name

Const EnabledConfig

EnabledConfig: object

interface: An interface representing EnabledConfig. Enabled configuration.

Optional enabled

enabled: undefined | false | true

member: {boolean} [enabled] True if configuration is enabled, false if it is disabled and null if configuration is not set.

serializedName

serializedName: string = "EnabledConfig"

type

type: object

className

className: string = "EnabledConfig"

name

modelProperties

modelProperties: object

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

Const ErrorEntity

ErrorEntity: object

interface: An interface representing ErrorEntity. Body of the error response returned from the API.

Optional code

code: undefined | string

member: {string} [code] Basic error code.

Optional extendedCode

extendedCode: undefined | string

member: {string} [extendedCode] Type of error.

Optional innerErrors

innerErrors: ErrorEntity[]

member: {ErrorEntity[]} [innerErrors] Inner errors.

Optional message

message: undefined | string

member: {string} [message] Any details of the error.

Optional messageTemplate

messageTemplate: undefined | string

member: {string} [messageTemplate] Message template.

Optional parameters

parameters: string[]

member: {string[]} [parameters] Parameters for the template.

serializedName

serializedName: string = "ErrorEntity"

type

type: object

className

className: string = "ErrorEntity"

name

modelProperties

name

element

element: object

type

type: object

name

Const Experiments

Experiments: object

interface: An interface representing Experiments. Routing rules in production experiments.

Optional rampUpRules

rampUpRules: RampUpRule[]

member: {RampUpRule[]} [rampUpRules] List of ramp-up rules.

serializedName

serializedName: string = "Experiments"

type

type: object

className

className: string = "Experiments"

name

modelProperties

modelProperties: object

rampUpRules

rampUpRules: object

serializedName

serializedName: string = "rampUpRules"

type

type: object

name

element

element: object

type

type: object

className

className: string = "RampUpRule"

name

Const FileSystemApplicationLogsConfig

FileSystemApplicationLogsConfig: object

interface: An interface representing FileSystemApplicationLogsConfig. Application logs to file system configuration.

Optional level

level: LogLevel

member: {LogLevel} [level] Log level. Possible values include: 'Off', 'Verbose', 'Information', 'Warning', 'Error'. Default value: 'Off' .

serializedName

serializedName: string = "FileSystemApplicationLogsConfig"

type

type: object

className

className: string = "FileSystemApplicationLogsConfig"

name

modelProperties

modelProperties: object

level

level: object

defaultValue

defaultValue: string = "Off"

serializedName

serializedName: string = "level"

type

type: object

allowedValues

allowedValues: string[] = ["Off","Verbose","Information","Warning","Error"]

name

Const FileSystemHttpLogsConfig

FileSystemHttpLogsConfig: object

interface: An interface representing FileSystemHttpLogsConfig. Http logs to file system configuration.

Optional enabled

enabled: undefined | false | true

member: {boolean} [enabled] True if configuration is enabled, false if it is disabled and null if configuration is not set.

Optional retentionInDays

retentionInDays: undefined | number

member: {number} [retentionInDays] Retention in days. Remove files older than X days. 0 or lower means no retention.

Optional retentionInMb

retentionInMb: undefined | number

member: {number} [retentionInMb] Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. Value can range between 25 and 100.

serializedName

serializedName: string = "FileSystemHttpLogsConfig"

type

type: object

className

className: string = "FileSystemHttpLogsConfig"

name

modelProperties

InclusiveMaximum

InclusiveMaximum: number = 100

InclusiveMinimum

InclusiveMinimum: number = 25

type

type: object

name

Const FunctionEnvelope

FunctionEnvelope: object

interface: An interface representing FunctionEnvelope. Web Job Information.
extends: ProxyOnlyResource

Optional config

config: any

member: {any} [config] Config information.

Optional configHref

configHref: undefined | string

member: {string} [configHref] Config URI.

Optional files

files: undefined | object

member: {{ [propertyName: string]: string }} [files] File list.

Optional functionAppId

functionAppId: undefined | string

member: {string} [functionAppId] Function App ID.

Optional href

href: undefined | string

member: {string} [href] Function URI.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scriptHref

scriptHref: undefined | string

member: {string} [scriptHref] Script URI.

Optional scriptRootPathHref

scriptRootPathHref: undefined | string

member: {string} [scriptRootPathHref] Script root path URI.

Optional secretsFileHref

secretsFileHref: undefined | string

member: {string} [secretsFileHref] Secrets file URI.

serializedName

serializedName: string = "FunctionEnvelope"

Optional testData

testData: undefined | string

member: {string} [testData] Test data used when testing via the Azure Portal.

type

type: object

className

className: string = "FunctionEnvelope"

name

modelProperties

FunctionEnvelopeCollection: object

interface: An interface representing the FunctionEnvelopeCollection. Collection of Kudu function information elements.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "FunctionEnvelopeCollection"

__@iterator

__@iterator(): IterableIterator<FunctionEnvelope>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<FunctionEnvelope>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<FunctionEnvelope>[]): FunctionEnvelope[]
concat(...items: (T | ConcatArray<T>)[]): FunctionEnvelope[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<FunctionEnvelope>[]
 
 Additional items to add to the end of array1.
Returns FunctionEnvelope[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns FunctionEnvelope[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, FunctionEnvelope]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, FunctionEnvelope]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): boolean
    - Parameters
      - value: FunctionEnvelope
      - index: number
      - array: FunctionEnvelope[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: FunctionEnvelope, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: FunctionEnvelope
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): FunctionEnvelope[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: FunctionEnvelope
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): boolean
    - Parameters
      - value: FunctionEnvelope
      - index: number
      - array: FunctionEnvelope[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): any
    - Parameters
      - value: FunctionEnvelope
      - index: number
      - array: FunctionEnvelope[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns FunctionEnvelope[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): FunctionEnvelope | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: FunctionEnvelope
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: FunctionEnvelope, index: number, obj: FunctionEnvelope[]): boolean
    - Parameters
      - this: void
      - value: FunctionEnvelope
      - index: number
      - obj: FunctionEnvelope[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: FunctionEnvelope, index: number, obj: FunctionEnvelope[]): boolean
    - Parameters
      - value: FunctionEnvelope
      - index: number
      - obj: FunctionEnvelope[]
      Returns boolean
- Optional thisArg: any
Returns FunctionEnvelope | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: FunctionEnvelope, index: number, obj: FunctionEnvelope[]): boolean
    - Parameters
      - value: FunctionEnvelope
      - index: number
      - obj: FunctionEnvelope[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): void
    - Parameters
      - value: FunctionEnvelope
      - index: number
      - array: FunctionEnvelope[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: FunctionEnvelope, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: FunctionEnvelope
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: FunctionEnvelope, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: FunctionEnvelope
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: FunctionEnvelope, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: FunctionEnvelope
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): U
    - Parameters
      - value: FunctionEnvelope
      - index: number
      - array: FunctionEnvelope[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): FunctionEnvelope | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns FunctionEnvelope | undefined

push

push(...items: FunctionEnvelope[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: FunctionEnvelope[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): FunctionEnvelope
reduce(callbackfn: function, initialValue: FunctionEnvelope): FunctionEnvelope
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: FunctionEnvelope, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): FunctionEnvelope
    - Parameters
      - previousValue: FunctionEnvelope
      - currentValue: FunctionEnvelope
      - currentIndex: number
      - array: FunctionEnvelope[]
      Returns FunctionEnvelope
Returns FunctionEnvelope
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: FunctionEnvelope, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): FunctionEnvelope
    - Parameters
      - previousValue: FunctionEnvelope
      - currentValue: FunctionEnvelope
      - currentIndex: number
      - array: FunctionEnvelope[]
      Returns FunctionEnvelope
- initialValue: FunctionEnvelope
Returns FunctionEnvelope
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): U
    - Parameters
      - previousValue: U
      - currentValue: FunctionEnvelope
      - currentIndex: number
      - array: FunctionEnvelope[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): FunctionEnvelope
reduceRight(callbackfn: function, initialValue: FunctionEnvelope): FunctionEnvelope
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: FunctionEnvelope, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): FunctionEnvelope
    - Parameters
      - previousValue: FunctionEnvelope
      - currentValue: FunctionEnvelope
      - currentIndex: number
      - array: FunctionEnvelope[]
      Returns FunctionEnvelope
Returns FunctionEnvelope
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: FunctionEnvelope, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): FunctionEnvelope
    - Parameters
      - previousValue: FunctionEnvelope
      - currentValue: FunctionEnvelope
      - currentIndex: number
      - array: FunctionEnvelope[]
      Returns FunctionEnvelope
- initialValue: FunctionEnvelope
Returns FunctionEnvelope
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: FunctionEnvelope, currentIndex: number, array: FunctionEnvelope[]): U
    - Parameters
      - previousValue: U
      - currentValue: FunctionEnvelope
      - currentIndex: number
      - array: FunctionEnvelope[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): FunctionEnvelope[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns FunctionEnvelope[]

shift

shift(): FunctionEnvelope | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns FunctionEnvelope | undefined

slice

slice(start?: undefined | number, end?: undefined | number): FunctionEnvelope[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns FunctionEnvelope[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: FunctionEnvelope, index: number, array: FunctionEnvelope[]): boolean
    - Parameters
      - value: FunctionEnvelope
      - index: number
      - array: FunctionEnvelope[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): FunctionEnvelope[]
splice(start: number, deleteCount: number, ...items: FunctionEnvelope[]): FunctionEnvelope[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns FunctionEnvelope[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: FunctionEnvelope[]
  
  Elements to insert into the array in place of the deleted elements.
Returns FunctionEnvelope[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: FunctionEnvelope[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: FunctionEnvelope[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<FunctionEnvelope>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<FunctionEnvelope>

type

type: object

className

className: string = "FunctionEnvelopeCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "FunctionEnvelope"

name

Const FunctionSecrets

FunctionSecrets: object

interface: An interface representing FunctionSecrets. Function secrets.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional key

key: undefined | string

member: {string} [key] Secret key.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "FunctionSecrets"

Optional triggerUrl

triggerUrl: undefined | string

member: {string} [triggerUrl] Trigger URL.

type

type: object

className

className: string = "FunctionSecrets"

name

modelProperties

modelProperties: object

key

key: object

serializedName

serializedName: string = "properties.key"

type

type: object

name

triggerUrl

triggerUrl: object

serializedName

serializedName: string = "properties.trigger_url"

type

type: object

name

Const GeoRegion

GeoRegion: object

interface: An interface representing GeoRegion. Geographical region.
extends: ProxyOnlyResource

Optional description

description: undefined | string

member: {string} [description] Region description. NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayName

displayName: undefined | string

member: {string} [displayName] Display name for region. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "GeoRegion"

type

type: object

className

className: string = "GeoRegion"

name

modelProperties

modelProperties: object

description

description: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.description"

type

type: object

name

displayName

displayName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

Const GeoRegionCollection

GeoRegionCollection: object

interface: An interface representing the GeoRegionCollection. Collection of geographical regions.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "GeoRegionCollection"

__@iterator

__@iterator(): IterableIterator<GeoRegion>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<GeoRegion>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<GeoRegion>[]): GeoRegion[]
concat(...items: (T | ConcatArray<T>)[]): GeoRegion[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<GeoRegion>[]
 
 Additional items to add to the end of array1.
Returns GeoRegion[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns GeoRegion[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, GeoRegion]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, GeoRegion]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: GeoRegion, index: number, array: GeoRegion[]): boolean
    - Parameters
      - value: GeoRegion
      - index: number
      - array: GeoRegion[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: GeoRegion, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: GeoRegion
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): GeoRegion[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: GeoRegion
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: GeoRegion, index: number, array: GeoRegion[]): boolean
    - Parameters
      - value: GeoRegion
      - index: number
      - array: GeoRegion[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: GeoRegion, index: number, array: GeoRegion[]): any
    - Parameters
      - value: GeoRegion
      - index: number
      - array: GeoRegion[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns GeoRegion[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): GeoRegion | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: GeoRegion
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: GeoRegion, index: number, obj: GeoRegion[]): boolean
    - Parameters
      - this: void
      - value: GeoRegion
      - index: number
      - obj: GeoRegion[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: GeoRegion, index: number, obj: GeoRegion[]): boolean
    - Parameters
      - value: GeoRegion
      - index: number
      - obj: GeoRegion[]
      Returns boolean
- Optional thisArg: any
Returns GeoRegion | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: GeoRegion, index: number, obj: GeoRegion[]): boolean
    - Parameters
      - value: GeoRegion
      - index: number
      - obj: GeoRegion[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: GeoRegion, index: number, array: GeoRegion[]): void
    - Parameters
      - value: GeoRegion
      - index: number
      - array: GeoRegion[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: GeoRegion, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: GeoRegion
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: GeoRegion, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: GeoRegion
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: GeoRegion, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: GeoRegion
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: GeoRegion, index: number, array: GeoRegion[]): U
    - Parameters
      - value: GeoRegion
      - index: number
      - array: GeoRegion[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): GeoRegion | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns GeoRegion | undefined

push

push(...items: GeoRegion[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: GeoRegion[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): GeoRegion
reduce(callbackfn: function, initialValue: GeoRegion): GeoRegion
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: GeoRegion, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): GeoRegion
    - Parameters
      - previousValue: GeoRegion
      - currentValue: GeoRegion
      - currentIndex: number
      - array: GeoRegion[]
      Returns GeoRegion
Returns GeoRegion
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: GeoRegion, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): GeoRegion
    - Parameters
      - previousValue: GeoRegion
      - currentValue: GeoRegion
      - currentIndex: number
      - array: GeoRegion[]
      Returns GeoRegion
- initialValue: GeoRegion
Returns GeoRegion
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): U
    - Parameters
      - previousValue: U
      - currentValue: GeoRegion
      - currentIndex: number
      - array: GeoRegion[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): GeoRegion
reduceRight(callbackfn: function, initialValue: GeoRegion): GeoRegion
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: GeoRegion, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): GeoRegion
    - Parameters
      - previousValue: GeoRegion
      - currentValue: GeoRegion
      - currentIndex: number
      - array: GeoRegion[]
      Returns GeoRegion
Returns GeoRegion
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: GeoRegion, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): GeoRegion
    - Parameters
      - previousValue: GeoRegion
      - currentValue: GeoRegion
      - currentIndex: number
      - array: GeoRegion[]
      Returns GeoRegion
- initialValue: GeoRegion
Returns GeoRegion
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: GeoRegion, currentIndex: number, array: GeoRegion[]): U
    - Parameters
      - previousValue: U
      - currentValue: GeoRegion
      - currentIndex: number
      - array: GeoRegion[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): GeoRegion[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns GeoRegion[]

shift

shift(): GeoRegion | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns GeoRegion | undefined

slice

slice(start?: undefined | number, end?: undefined | number): GeoRegion[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns GeoRegion[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: GeoRegion, index: number, array: GeoRegion[]): boolean
    - Parameters
      - value: GeoRegion
      - index: number
      - array: GeoRegion[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): GeoRegion[]
splice(start: number, deleteCount: number, ...items: GeoRegion[]): GeoRegion[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns GeoRegion[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: GeoRegion[]
  
  Elements to insert into the array in place of the deleted elements.
Returns GeoRegion[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: GeoRegion[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: GeoRegion[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<GeoRegion>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<GeoRegion>

type

type: object

className

className: string = "GeoRegionCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "GeoRegion"

name

Const GlobalCsmSkuDescription

GlobalCsmSkuDescription: object

interface: An interface representing GlobalCsmSkuDescription. A Global SKU Description.

Optional capabilities

capabilities: Capability[]

member: {Capability[]} [capabilities] Capabilities of the SKU, e.g., is traffic manager enabled?

Optional capacity

capacity: SkuCapacity

member: {SkuCapacity} [capacity] Min, max, and default scale values of the SKU.

Optional family

family: undefined | string

member: {string} [family] Family code of the resource SKU.

Optional locations

locations: string[]

member: {string[]} [locations] Locations of the SKU.

Optional name

member: {string} [name] Name of the resource SKU.

serializedName

serializedName: string = "GlobalCsmSkuDescription"

Optional size

size: undefined | string

member: {string} [size] Size specifier of the resource SKU.

Optional tier

tier: undefined | string

member: {string} [tier] Service Tier of the resource SKU.

type

type: object

className

className: string = "GlobalCsmSkuDescription"

name

modelProperties

size: object

serializedName

serializedName: string = "size"

type

type: object

name

tier

tier: object

serializedName

serializedName: string = "tier"

type

type: object

name

Const HandlerMapping

HandlerMapping: object

interface: An interface representing HandlerMapping. The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.

Optional argumentsProperty

argumentsProperty: undefined | string

member: {string} [argumentsProperty] Command-line arguments to be passed to the script processor.

Optional extension

extension: undefined | string

member: {string} [extension] Requests with this extension will be handled using the specified FastCGI application.

Optional scriptProcessor

scriptProcessor: undefined | string

member: {string} [scriptProcessor] The absolute path to the FastCGI application.

serializedName

serializedName: string = "HandlerMapping"

type

type: object

className

className: string = "HandlerMapping"

name

modelProperties

name

Const HostName

HostName: object

interface: An interface representing HostName. Details of a hostname derived from a domain.

Optional azureResourceName

azureResourceName: undefined | string

member: {string} [azureResourceName] Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.

Optional azureResourceType

azureResourceType: AzureResourceType

member: {AzureResourceType} [azureResourceType] Type of the Azure resource the hostname is assigned to. Possible values include: 'Website', 'TrafficManager'

Optional customHostNameDnsRecordType

customHostNameDnsRecordType: CustomHostNameDnsRecordType

member: {CustomHostNameDnsRecordType} [customHostNameDnsRecordType] Type of the DNS record. Possible values include: 'CName', 'A'

Optional hostNameType

hostNameType: HostNameType

member: {HostNameType} [hostNameType] Type of the hostname. Possible values include: 'Verified', 'Managed'

Optional name

member: {string} [name] Name of the hostname.

serializedName

serializedName: string = "HostName"

Optional siteNames

siteNames: string[]

member: {string[]} [siteNames] List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager.

type

type: object

allowedValues

allowedValues: string[] = ["Verified","Managed"]

name

name

serializedName

serializedName: string = "name"

type

type: object

name

siteNames

siteNames: object

serializedName

serializedName: string = "siteNames"

type

type: object

name

element

element: object

type

type: object

name

Const HostNameBinding

HostNameBinding: object

interface: An interface representing HostNameBinding. A hostname binding object.
extends: ProxyOnlyResource

Optional azureResourceName

azureResourceName: undefined | string

member: {string} [azureResourceName] Azure resource name.

Optional azureResourceType

azureResourceType: AzureResourceType

member: {AzureResourceType} [azureResourceType] Azure resource type. Possible values include: 'Website', 'TrafficManager'

Optional customHostNameDnsRecordType

customHostNameDnsRecordType: CustomHostNameDnsRecordType

member: {CustomHostNameDnsRecordType} [customHostNameDnsRecordType] Custom DNS record type. Possible values include: 'CName', 'A'

Optional domainId

domainId: undefined | string

member: {string} [domainId] Fully qualified ARM domain resource URI.

Optional hostNameType

hostNameType: HostNameType

member: {HostNameType} [hostNameType] Hostname type. Possible values include: 'Verified', 'Managed'

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HostNameBinding"

Optional siteName

siteName: undefined | string

member: {string} [siteName] App Service app name.

Optional sslState

sslState: SslState

member: {SslState} [sslState] SSL type. Possible values include: 'Disabled', 'SniEnabled', 'IpBasedEnabled'

Optional thumbprint

thumbprint: undefined | string

member: {string} [thumbprint] SSL certificate thumbprint

Optional virtualIP

virtualIP: undefined | string

member: {string} [virtualIP] Virtual IP address assigned to the hostname if IP based SSL is enabled. NOTE: This property will not be serialized. It can only be populated by the server.

allowedValues

allowedValues: string[] = ["Verified","Managed"]

name

siteName

siteName: object

serializedName

serializedName: string = "properties.siteName"

type

type: object

name

sslState

type

type: object

name

Const HostNameBindingCollection

HostNameBindingCollection: object

interface: An interface representing the HostNameBindingCollection. Collection of hostname bindings.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HostNameBindingCollection"

__@iterator

__@iterator(): IterableIterator<HostNameBinding>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<HostNameBinding>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<HostNameBinding>[]): HostNameBinding[]
concat(...items: (T | ConcatArray<T>)[]): HostNameBinding[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<HostNameBinding>[]
 
 Additional items to add to the end of array1.
Returns HostNameBinding[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns HostNameBinding[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, HostNameBinding]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, HostNameBinding]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: HostNameBinding, index: number, array: HostNameBinding[]): boolean
    - Parameters
      - value: HostNameBinding
      - index: number
      - array: HostNameBinding[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: HostNameBinding, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: HostNameBinding
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): HostNameBinding[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: HostNameBinding
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: HostNameBinding, index: number, array: HostNameBinding[]): boolean
    - Parameters
      - value: HostNameBinding
      - index: number
      - array: HostNameBinding[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: HostNameBinding, index: number, array: HostNameBinding[]): any
    - Parameters
      - value: HostNameBinding
      - index: number
      - array: HostNameBinding[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns HostNameBinding[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): HostNameBinding | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: HostNameBinding
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: HostNameBinding, index: number, obj: HostNameBinding[]): boolean
    - Parameters
      - this: void
      - value: HostNameBinding
      - index: number
      - obj: HostNameBinding[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: HostNameBinding, index: number, obj: HostNameBinding[]): boolean
    - Parameters
      - value: HostNameBinding
      - index: number
      - obj: HostNameBinding[]
      Returns boolean
- Optional thisArg: any
Returns HostNameBinding | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: HostNameBinding, index: number, obj: HostNameBinding[]): boolean
    - Parameters
      - value: HostNameBinding
      - index: number
      - obj: HostNameBinding[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: HostNameBinding, index: number, array: HostNameBinding[]): void
    - Parameters
      - value: HostNameBinding
      - index: number
      - array: HostNameBinding[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: HostNameBinding, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: HostNameBinding
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: HostNameBinding, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: HostNameBinding
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: HostNameBinding, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: HostNameBinding
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: HostNameBinding, index: number, array: HostNameBinding[]): U
    - Parameters
      - value: HostNameBinding
      - index: number
      - array: HostNameBinding[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): HostNameBinding | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns HostNameBinding | undefined

push

push(...items: HostNameBinding[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: HostNameBinding[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): HostNameBinding
reduce(callbackfn: function, initialValue: HostNameBinding): HostNameBinding
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: HostNameBinding, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): HostNameBinding
    - Parameters
      - previousValue: HostNameBinding
      - currentValue: HostNameBinding
      - currentIndex: number
      - array: HostNameBinding[]
      Returns HostNameBinding
Returns HostNameBinding
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: HostNameBinding, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): HostNameBinding
    - Parameters
      - previousValue: HostNameBinding
      - currentValue: HostNameBinding
      - currentIndex: number
      - array: HostNameBinding[]
      Returns HostNameBinding
- initialValue: HostNameBinding
Returns HostNameBinding
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): U
    - Parameters
      - previousValue: U
      - currentValue: HostNameBinding
      - currentIndex: number
      - array: HostNameBinding[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): HostNameBinding
reduceRight(callbackfn: function, initialValue: HostNameBinding): HostNameBinding
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: HostNameBinding, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): HostNameBinding
    - Parameters
      - previousValue: HostNameBinding
      - currentValue: HostNameBinding
      - currentIndex: number
      - array: HostNameBinding[]
      Returns HostNameBinding
Returns HostNameBinding
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: HostNameBinding, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): HostNameBinding
    - Parameters
      - previousValue: HostNameBinding
      - currentValue: HostNameBinding
      - currentIndex: number
      - array: HostNameBinding[]
      Returns HostNameBinding
- initialValue: HostNameBinding
Returns HostNameBinding
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: HostNameBinding, currentIndex: number, array: HostNameBinding[]): U
    - Parameters
      - previousValue: U
      - currentValue: HostNameBinding
      - currentIndex: number
      - array: HostNameBinding[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): HostNameBinding[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns HostNameBinding[]

shift

shift(): HostNameBinding | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns HostNameBinding | undefined

slice

slice(start?: undefined | number, end?: undefined | number): HostNameBinding[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns HostNameBinding[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: HostNameBinding, index: number, array: HostNameBinding[]): boolean
    - Parameters
      - value: HostNameBinding
      - index: number
      - array: HostNameBinding[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): HostNameBinding[]
splice(start: number, deleteCount: number, ...items: HostNameBinding[]): HostNameBinding[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns HostNameBinding[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: HostNameBinding[]
  
  Elements to insert into the array in place of the deleted elements.
Returns HostNameBinding[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: HostNameBinding[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: HostNameBinding[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<HostNameBinding>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<HostNameBinding>

type

type: object

className

className: string = "HostNameBindingCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "HostNameBinding"

name

Const HostNameSslState

HostNameSslState: object

interface: An interface representing HostNameSslState. SSL-enabled hostname.

Optional hostType

hostType: HostType

member: {HostType} [hostType] Indicates whether the hostname is a standard or repository hostname. Possible values include: 'Standard', 'Repository'

Optional name

member: {string} [name] Hostname.

serializedName

serializedName: string = "HostNameSslState"

Optional sslState

sslState: SslState

member: {SslState} [sslState] SSL type. Possible values include: 'Disabled', 'SniEnabled', 'IpBasedEnabled'

Optional thumbprint

thumbprint: undefined | string

member: {string} [thumbprint] SSL certificate thumbprint.

Optional toUpdate

toUpdate: undefined | false | true

member: {boolean} [toUpdate] Set to true to update existing hostname.

Optional virtualIP

virtualIP: undefined | string

member: {string} [virtualIP] Virtual IP address assigned to the hostname if IP based SSL is enabled.

type

type: object

className

className: string = "HostNameSslState"

name

modelProperties

modelProperties: object

hostType

hostType: object

serializedName

serializedName: string = "hostType"

type

type: object

allowedValues

allowedValues: string[] = ["Standard","Repository"]

type: object

name

Const HostingEnvironmentDeploymentInfo

HostingEnvironmentDeploymentInfo: object

interface: An interface representing HostingEnvironmentDeploymentInfo. Information needed to create resources on an App Service Environment.

Optional location

location: undefined | string

member: {string} [location] Location of the App Service Environment.

Optional name

member: {string} [name] Name of the App Service Environment.

serializedName

serializedName: string = "HostingEnvironmentDeploymentInfo"

type

type: object

className

className: string = "HostingEnvironmentDeploymentInfo"

name

modelProperties

modelProperties: object

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name

serializedName

serializedName: string = "name"

type

type: object

name

Const HostingEnvironmentDiagnostics

HostingEnvironmentDiagnostics: object

interface: An interface representing HostingEnvironmentDiagnostics. Diagnostics for an App Service Environment.

Optional diagnosicsOutput

diagnosicsOutput: undefined | string

member: {string} [diagnosicsOutput] Diagnostics output.

Optional name

member: {string} [name] Name/identifier of the diagnostics.

serializedName

serializedName: string = "HostingEnvironmentDiagnostics"

type

type: object

className

className: string = "HostingEnvironmentDiagnostics"

name

modelProperties

modelProperties: object

diagnosicsOutput

diagnosicsOutput: object

serializedName

serializedName: string = "diagnosicsOutput"

type

type: object

name

name

serializedName

serializedName: string = "name"

type

type: object

name

Const HostingEnvironmentProfile

HostingEnvironmentProfile: object

interface: An interface representing HostingEnvironmentProfile. Specification for an App Service Environment to use for this resource.

Optional id

id: undefined | string

member: {string} [id] Resource ID of the App Service Environment.

Optional name

member: {string} [name] Name of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HostingEnvironmentProfile"

type

type: object

member: {string} [type] Resource type of the App Service Environment. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "HostingEnvironmentProfile"

name

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

Const HttpLogsConfig

HttpLogsConfig: object

interface: An interface representing HttpLogsConfig. Http logs configuration.

Optional azureBlobStorage

azureBlobStorage: AzureBlobStorageHttpLogsConfig

member: {AzureBlobStorageHttpLogsConfig} [azureBlobStorage] Http logs to azure blob storage configuration.

Optional fileSystem

fileSystem: FileSystemHttpLogsConfig

member: {FileSystemHttpLogsConfig} [fileSystem] Http logs to file system configuration.

serializedName

serializedName: string = "HttpLogsConfig"

type

type: object

className

className: string = "HttpLogsConfig"

name

modelProperties

modelProperties: object

azureBlobStorage

azureBlobStorage: object

serializedName

serializedName: string = "azureBlobStorage"

type

type: object

className

className: string = "AzureBlobStorageHttpLogsConfig"

name

fileSystem

fileSystem: object

serializedName

serializedName: string = "fileSystem"

type

type: object

className

className: string = "FileSystemHttpLogsConfig"

name

Const HybridConnection

HybridConnection: object

interface: An interface representing HybridConnection. Hybrid Connection contract. This is used to configure a Hybrid Connection.
extends: ProxyOnlyResource

Optional hostname

hostname: undefined | string

member: {string} [hostname] The hostname of the endpoint.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional port

port: undefined | number

member: {number} [port] The port of the endpoint.

Optional relayArmUri

relayArmUri: undefined | string

member: {string} [relayArmUri] The ARM URI to the Service Bus relay.

Optional relayName

relayName: undefined | string

member: {string} [relayName] The name of the Service Bus relay.

Optional sendKeyName

sendKeyName: undefined | string

member: {string} [sendKeyName] The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.

Optional sendKeyValue

sendKeyValue: undefined | string

member: {string} [sendKeyValue] The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned normally, use the POST /listKeys API instead.

serializedName

serializedName: string = "HybridConnection"

Optional serviceBusNamespace

serviceBusNamespace: undefined | string

member: {string} [serviceBusNamespace] The name of the Service Bus namespace.

Optional serviceBusSuffix

serviceBusSuffix: undefined | string

member: {string} [serviceBusSuffix] The suffix for the service bus endpoint. By default this is .servicebus.windows.net

type

type: object

className

className: string = "HybridConnection"

name

modelProperties

name

Const HybridConnectionCollection

HybridConnectionCollection: object

interface: An interface representing the HybridConnectionCollection. Collection of hostname bindings.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HybridConnectionCollection"

__@iterator

__@iterator(): IterableIterator<HybridConnection>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<HybridConnection>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<HybridConnection>[]): HybridConnection[]
concat(...items: (T | ConcatArray<T>)[]): HybridConnection[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<HybridConnection>[]
 
 Additional items to add to the end of array1.
Returns HybridConnection[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns HybridConnection[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, HybridConnection]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, HybridConnection]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: HybridConnection, index: number, array: HybridConnection[]): boolean
    - Parameters
      - value: HybridConnection
      - index: number
      - array: HybridConnection[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: HybridConnection, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: HybridConnection
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): HybridConnection[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: HybridConnection
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: HybridConnection, index: number, array: HybridConnection[]): boolean
    - Parameters
      - value: HybridConnection
      - index: number
      - array: HybridConnection[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: HybridConnection, index: number, array: HybridConnection[]): any
    - Parameters
      - value: HybridConnection
      - index: number
      - array: HybridConnection[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns HybridConnection[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): HybridConnection | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: HybridConnection
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: HybridConnection, index: number, obj: HybridConnection[]): boolean
    - Parameters
      - this: void
      - value: HybridConnection
      - index: number
      - obj: HybridConnection[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: HybridConnection, index: number, obj: HybridConnection[]): boolean
    - Parameters
      - value: HybridConnection
      - index: number
      - obj: HybridConnection[]
      Returns boolean
- Optional thisArg: any
Returns HybridConnection | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: HybridConnection, index: number, obj: HybridConnection[]): boolean
    - Parameters
      - value: HybridConnection
      - index: number
      - obj: HybridConnection[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: HybridConnection, index: number, array: HybridConnection[]): void
    - Parameters
      - value: HybridConnection
      - index: number
      - array: HybridConnection[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: HybridConnection, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: HybridConnection
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: HybridConnection, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: HybridConnection
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: HybridConnection, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: HybridConnection
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: HybridConnection, index: number, array: HybridConnection[]): U
    - Parameters
      - value: HybridConnection
      - index: number
      - array: HybridConnection[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): HybridConnection | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns HybridConnection | undefined

push

push(...items: HybridConnection[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: HybridConnection[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): HybridConnection
reduce(callbackfn: function, initialValue: HybridConnection): HybridConnection
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: HybridConnection, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): HybridConnection
    - Parameters
      - previousValue: HybridConnection
      - currentValue: HybridConnection
      - currentIndex: number
      - array: HybridConnection[]
      Returns HybridConnection
Returns HybridConnection
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: HybridConnection, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): HybridConnection
    - Parameters
      - previousValue: HybridConnection
      - currentValue: HybridConnection
      - currentIndex: number
      - array: HybridConnection[]
      Returns HybridConnection
- initialValue: HybridConnection
Returns HybridConnection
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): U
    - Parameters
      - previousValue: U
      - currentValue: HybridConnection
      - currentIndex: number
      - array: HybridConnection[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): HybridConnection
reduceRight(callbackfn: function, initialValue: HybridConnection): HybridConnection
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: HybridConnection, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): HybridConnection
    - Parameters
      - previousValue: HybridConnection
      - currentValue: HybridConnection
      - currentIndex: number
      - array: HybridConnection[]
      Returns HybridConnection
Returns HybridConnection
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: HybridConnection, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): HybridConnection
    - Parameters
      - previousValue: HybridConnection
      - currentValue: HybridConnection
      - currentIndex: number
      - array: HybridConnection[]
      Returns HybridConnection
- initialValue: HybridConnection
Returns HybridConnection
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: HybridConnection, currentIndex: number, array: HybridConnection[]): U
    - Parameters
      - previousValue: U
      - currentValue: HybridConnection
      - currentIndex: number
      - array: HybridConnection[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): HybridConnection[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns HybridConnection[]

shift

shift(): HybridConnection | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns HybridConnection | undefined

slice

slice(start?: undefined | number, end?: undefined | number): HybridConnection[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns HybridConnection[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: HybridConnection, index: number, array: HybridConnection[]): boolean
    - Parameters
      - value: HybridConnection
      - index: number
      - array: HybridConnection[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): HybridConnection[]
splice(start: number, deleteCount: number, ...items: HybridConnection[]): HybridConnection[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns HybridConnection[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: HybridConnection[]
  
  Elements to insert into the array in place of the deleted elements.
Returns HybridConnection[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: HybridConnection[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: HybridConnection[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<HybridConnection>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<HybridConnection>

type

type: object

className

className: string = "HybridConnectionCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "HybridConnection"

name

Const HybridConnectionKey

HybridConnectionKey: object

interface: An interface representing HybridConnectionKey. Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sendKeyName

sendKeyName: undefined | string

member: {string} [sendKeyName] The name of the send key. NOTE: This property will not be serialized. It can only be populated by the server.

Optional sendKeyValue

sendKeyValue: undefined | string

member: {string} [sendKeyValue] The value of the send key. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HybridConnectionKey"

type

type: object

className

className: string = "HybridConnectionKey"

name

modelProperties

modelProperties: object

sendKeyName

sendKeyName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.sendKeyName"

type

type: object

name

sendKeyValue

sendKeyValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.sendKeyValue"

type

type: object

name

Const HybridConnectionLimits

HybridConnectionLimits: object

interface: An interface representing HybridConnectionLimits. Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.
extends: ProxyOnlyResource

Optional current

current: undefined | number

member: {number} [current] The current number of Hybrid Connections. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional maximum

maximum: undefined | number

member: {number} [maximum] The maximum number of Hybrid Connections allowed. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "HybridConnectionLimits"

type

type: object

className

className: string = "HybridConnectionLimits"

name

modelProperties

modelProperties: object

current

current: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.current"

type

type: object

name

maximum

maximum: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.maximum"

type

type: object

name

Const Identifier

Identifier: object

interface: An interface representing Identifier. A domain specific resource identifier.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identifierId

identifierId: undefined | string

member: {string} [identifierId] String representation of the identity.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Identifier"

type

type: object

className

className: string = "Identifier"

name

modelProperties

modelProperties: object

identifierId

identifierId: object

serializedName

serializedName: string = "properties.id"

type

type: object

name

Const IdentifierCollection

IdentifierCollection: object

interface: An interface representing the IdentifierCollection. Collection of identifiers.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "IdentifierCollection"

__@iterator

__@iterator(): IterableIterator<Identifier>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<Identifier>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<Identifier>[]): Identifier[]
concat(...items: (T | ConcatArray<T>)[]): Identifier[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<Identifier>[]
 
 Additional items to add to the end of array1.
Returns Identifier[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns Identifier[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, Identifier]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, Identifier]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: Identifier, index: number, array: Identifier[]): boolean
    - Parameters
      - value: Identifier
      - index: number
      - array: Identifier[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: Identifier, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: Identifier
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): Identifier[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: Identifier
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Identifier, index: number, array: Identifier[]): boolean
    - Parameters
      - value: Identifier
      - index: number
      - array: Identifier[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Identifier, index: number, array: Identifier[]): any
    - Parameters
      - value: Identifier
      - index: number
      - array: Identifier[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Identifier[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): Identifier | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: Identifier
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: Identifier, index: number, obj: Identifier[]): boolean
    - Parameters
      - this: void
      - value: Identifier
      - index: number
      - obj: Identifier[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: Identifier, index: number, obj: Identifier[]): boolean
    - Parameters
      - value: Identifier
      - index: number
      - obj: Identifier[]
      Returns boolean
- Optional thisArg: any
Returns Identifier | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: Identifier, index: number, obj: Identifier[]): boolean
    - Parameters
      - value: Identifier
      - index: number
      - obj: Identifier[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: Identifier, index: number, array: Identifier[]): void
    - Parameters
      - value: Identifier
      - index: number
      - array: Identifier[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: Identifier, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: Identifier
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: Identifier, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: Identifier
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: Identifier, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: Identifier
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: Identifier, index: number, array: Identifier[]): U
    - Parameters
      - value: Identifier
      - index: number
      - array: Identifier[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): Identifier | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns Identifier | undefined

push

push(...items: Identifier[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: Identifier[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): Identifier
reduce(callbackfn: function, initialValue: Identifier): Identifier
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Identifier, currentValue: Identifier, currentIndex: number, array: Identifier[]): Identifier
    - Parameters
      - previousValue: Identifier
      - currentValue: Identifier
      - currentIndex: number
      - array: Identifier[]
      Returns Identifier
Returns Identifier
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: Identifier, currentValue: Identifier, currentIndex: number, array: Identifier[]): Identifier
    - Parameters
      - previousValue: Identifier
      - currentValue: Identifier
      - currentIndex: number
      - array: Identifier[]
      Returns Identifier
- initialValue: Identifier
Returns Identifier
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Identifier, currentIndex: number, array: Identifier[]): U
    - Parameters
      - previousValue: U
      - currentValue: Identifier
      - currentIndex: number
      - array: Identifier[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): Identifier
reduceRight(callbackfn: function, initialValue: Identifier): Identifier
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Identifier, currentValue: Identifier, currentIndex: number, array: Identifier[]): Identifier
    - Parameters
      - previousValue: Identifier
      - currentValue: Identifier
      - currentIndex: number
      - array: Identifier[]
      Returns Identifier
Returns Identifier
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: Identifier, currentValue: Identifier, currentIndex: number, array: Identifier[]): Identifier
    - Parameters
      - previousValue: Identifier
      - currentValue: Identifier
      - currentIndex: number
      - array: Identifier[]
      Returns Identifier
- initialValue: Identifier
Returns Identifier
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Identifier, currentIndex: number, array: Identifier[]): U
    - Parameters
      - previousValue: U
      - currentValue: Identifier
      - currentIndex: number
      - array: Identifier[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): Identifier[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns Identifier[]

shift

shift(): Identifier | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns Identifier | undefined

slice

slice(start?: undefined | number, end?: undefined | number): Identifier[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns Identifier[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: Identifier, index: number, array: Identifier[]): boolean
    - Parameters
      - value: Identifier
      - index: number
      - array: Identifier[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): Identifier[]
splice(start: number, deleteCount: number, ...items: Identifier[]): Identifier[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns Identifier[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: Identifier[]
  
  Elements to insert into the array in place of the deleted elements.
Returns Identifier[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: Identifier[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: Identifier[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<Identifier>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<Identifier>

type

type: object

className

className: string = "IdentifierCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "Identifier"

name

Const IpSecurityRestriction

IpSecurityRestriction: object

interface: An interface representing IpSecurityRestriction. IP security restriction on an app.

Optional action

action: undefined | string

member: {string} [action] Allow or Deny access for this IP range.

Optional description

description: undefined | string

member: {string} [description] IP restriction rule description.

ipAddress

ipAddress: string

member: {string} ipAddress IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified.

Optional name

member: {string} [name] IP restriction rule name.

Optional priority

priority: undefined | number

member: {number} [priority] Priority of IP restriction rule.

serializedName

serializedName: string = "IpSecurityRestriction"

Optional subnetMask

subnetMask: undefined | string

member: {string} [subnetMask] Subnet mask for the range of IP addresses the restriction is valid for.

Optional tag

tag: IpFilterTag

member: {IpFilterTag} [tag] Defines what this IP filter will be used for. This is to support IP filtering on proxies. Possible values include: 'Default', 'XffProxy'

type

type: object

className

className: string = "IpSecurityRestriction"

name

modelProperties

type

type: object

allowedValues: string[] = ["Default","XffProxy"]

name

Const LocalizableString

LocalizableString: object

interface: An interface representing LocalizableString. Localizable string object containing the name and a localized value.

Optional localizedValue

localizedValue: undefined | string

member: {string} [localizedValue] Localized name.

serializedName

serializedName: string = "LocalizableString"

Optional value

value: undefined | string

member: {string} [value] Non-localized name.

type

type: object

className

className: string = "LocalizableString"

name

modelProperties

modelProperties: object

localizedValue

localizedValue: object

serializedName

serializedName: string = "localizedValue"

type

type: object

name

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

Const LogSpecification

LogSpecification: object

interface: An interface representing LogSpecification. Log Definition of a single resource metric.

Optional blobDuration

blobDuration: undefined | string

member: {string} [blobDuration]

Optional displayName

displayName: undefined | string

member: {string} [displayName]

Optional name

member: {string} [name]

serializedName

serializedName: string = "LogSpecification"

type

type: object

className

className: string = "LogSpecification"

name

modelProperties

modelProperties: object

blobDuration

blobDuration: object

serializedName

serializedName: string = "blobDuration"

type

type: object

name

displayName

displayName: object

serializedName

serializedName: string = "displayName"

type

type: object

name

name

serializedName

serializedName: string = "name"

type

type: object

name

Const MSDeploy

MSDeploy: object

interface: An interface representing MSDeploy. MSDeploy ARM PUT information
extends: ProxyOnlyResource

Optional appOffline

appOffline: undefined | false | true

member: {boolean} [appOffline] Sets the AppOffline rule while the MSDeploy operation executes. Setting is false by default.

Optional connectionString

connectionString: undefined | string

member: {string} [connectionString] SQL Connection String

Optional dbType

dbType: undefined | string

member: {string} [dbType] Database Type

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional packageUri

packageUri: undefined | string

member: {string} [packageUri] Package URI

serializedName

serializedName: string = "MSDeploy"

Optional setParameters

setParameters: undefined | object

member: {{ [propertyName: string]: string }} [setParameters] MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.

Optional setParametersXmlFileUri

setParametersXmlFileUri: undefined | string

member: {string} [setParametersXmlFileUri] URI of MSDeploy Parameters file. Must not be set if SetParameters is used.

Optional skipAppData

skipAppData: undefined | false | true

member: {boolean} [skipAppData] Controls whether the MSDeploy operation skips the App_Data directory. If set to true, the existing App_Data directory on the destination will not be deleted, and any App_Data directory in the source will be ignored. Setting is false by default.

type

type: object

className

className: string = "MSDeploy"

name

modelProperties

MSDeployLog: object

interface: An interface representing MSDeployLog. MSDeploy log
extends: ProxyOnlyResource

Optional entries

entries: MSDeployLogEntry[]

member: {MSDeployLogEntry[]} [entries] List of log entry messages NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MSDeployLog"

type

type: object

className

className: string = "MSDeployLog"

name

modelProperties

modelProperties: object

entries

entries: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.entries"

type

type: object

name

element

element: object

type

type: object

className

className: string = "MSDeployLogEntry"

name

Const MSDeployLogEntry

MSDeployLogEntry: object

interface: An interface representing MSDeployLogEntry. MSDeploy log entry

Optional message

message: undefined | string

member: {string} [message] Log entry message NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MSDeployLogEntry"

Optional time

time: Date

member: {Date} [time] Timestamp of log entry NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

member: {MSDeployLogEntryType} [type] Log entry type. Possible values include: 'Message', 'Warning', 'Error' NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "MSDeployLogEntry"

name

modelProperties

allowedValues

allowedValues: string[] = ["Message","Warning","Error"]

name

Const MSDeployStatus

MSDeployStatus: object

interface: An interface representing MSDeployStatus. MSDeploy ARM response
extends: ProxyOnlyResource

Optional complete

complete: undefined | false | true

member: {boolean} [complete] Whether the deployment operation has completed NOTE: This property will not be serialized. It can only be populated by the server.

Optional deployer

deployer: undefined | string

member: {string} [deployer] Username of deployer NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date

member: {Date} [endTime] End time of deploy operation NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

provisioningState: MSDeployProvisioningState

member: {MSDeployProvisioningState} [provisioningState] Provisioning state. Possible values include: 'accepted', 'running', 'succeeded', 'failed', 'canceled' NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MSDeployStatus"

Optional startTime

startTime: Date

member: {Date} [startTime] Start time of deploy operation NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "MSDeployStatus"

name

modelProperties

allowedValues

allowedValues: string[] = ["accepted","running","succeeded","failed","canceled"]

name

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

Const ManagedServiceIdentity

ManagedServiceIdentity: object

interface: An interface representing ManagedServiceIdentity. Managed service identity.

Optional identityIds

identityIds: string[]

member: {string[]} [identityIds] Array of UserAssigned managed service identities.

Optional principalId

principalId: undefined | string

member: {string} [principalId] Principal Id of managed service identity. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ManagedServiceIdentity"

Optional tenantId

tenantId: undefined | string

member: {string} [tenantId] Tenant of managed service identity. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

member: {ManagedServiceIdentityType} [type] Type of managed service identity. Possible values include: 'SystemAssigned', 'UserAssigned'

className

className: string = "ManagedServiceIdentity"

name

modelProperties

modelProperties: object

identityIds

identityIds: object

serializedName

serializedName: string = "identityIds"

type

type: object

serializedName: string = "type"

type

type: object

name

Const MetricAvailabilily

MetricAvailabilily: object

interface: An interface representing MetricAvailabilily. Metric availability and retention.

Optional retention

retention: undefined | string

member: {string} [retention] Retention period for the current time grain.

serializedName

serializedName: string = "MetricAvailabilily"

Optional timeGrain

timeGrain: undefined | string

member: {string} [timeGrain] Time grain.

type

type: object

className

className: string = "MetricAvailabilily"

name

modelProperties

modelProperties: object

retention

retention: object

serializedName

serializedName: string = "retention"

type

type: object

name

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

Const MetricAvailability

MetricAvailability: object

interface: An interface representing MetricAvailability. Retention policy of a resource metric.

Optional blobDuration

blobDuration: undefined | string

member: {string} [blobDuration]

serializedName

serializedName: string = "MetricAvailability"

Optional timeGrain

timeGrain: undefined | string

member: {string} [timeGrain]

type

type: object

className

className: string = "MetricAvailability"

name

modelProperties

modelProperties: object

blobDuration

blobDuration: object

serializedName

serializedName: string = "blobDuration"

type

type: object

name

timeGrain

timeGrain: object

serializedName

serializedName: string = "timeGrain"

type

type: object

name

Const MetricDefinition

MetricDefinition: object

interface: An interface representing MetricDefinition. Metadata for a metric.
extends: ProxyOnlyResource

Optional displayName

displayName: undefined | string

member: {string} [displayName] Friendly name shown in the UI. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional metricAvailabilities

metricAvailabilities: MetricAvailabilily[]

member: {MetricAvailabilily[]} [metricAvailabilities] List of time grains supported for the metric together with retention period. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional primaryAggregationType

primaryAggregationType: undefined | string

member: {string} [primaryAggregationType] Primary aggregation type. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MetricDefinition"

Optional unit

unit: undefined | string

member: {string} [unit] Unit of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "MetricDefinition"

name

modelProperties

modelProperties: object

displayName

displayName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.displayName"

type

type: object

name

metricAvailabilities

metricAvailabilities: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.metricAvailabilities"

type

type: object

MetricSpecification: object

interface: An interface representing MetricSpecification. Definition of a single resource metric.

Optional aggregationType

aggregationType: undefined | string

member: {string} [aggregationType]

Optional availabilities

availabilities: MetricAvailability[]

member: {MetricAvailability[]} [availabilities]

Optional category

category: undefined | string

member: {string} [category]

Optional dimensions

dimensions: Dimension[]

member: {Dimension[]} [dimensions]

Optional displayDescription

displayDescription: undefined | string

member: {string} [displayDescription]

Optional displayName

displayName: undefined | string

member: {string} [displayName]

Optional enableRegionalMdmAccount

enableRegionalMdmAccount: undefined | false | true

member: {boolean} [enableRegionalMdmAccount]

Optional fillGapWithZero

fillGapWithZero: undefined | false | true

member: {boolean} [fillGapWithZero]

Optional isInternal

isInternal: undefined | false | true

member: {boolean} [isInternal]

Optional metricFilterPattern

metricFilterPattern: undefined | string

member: {string} [metricFilterPattern]

Optional name

member: {string} [name]

serializedName

serializedName: string = "MetricSpecification"

Optional sourceMdmAccount

sourceMdmAccount: undefined | string

member: {string} [sourceMdmAccount]

Optional sourceMdmNamespace

sourceMdmNamespace: undefined | string

member: {string} [sourceMdmNamespace]

Optional supportsInstanceLevelAggregation

supportsInstanceLevelAggregation: undefined | false | true

member: {boolean} [supportsInstanceLevelAggregation]

Optional unit

unit: undefined | string

member: {string} [unit]

type

type: object

className

className: string = "MetricSpecification"

name

modelProperties

interface: An interface representing MigrateMySqlRequest. MySQL migration request.
extends: ProxyOnlyResource

connectionString

connectionString: string

member: {string} connectionString Connection string to the remote MySQL database.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

migrationType

migrationType: MySqlMigrationType

member: {MySqlMigrationType} migrationType The type of migration operation to be done. Possible values include: 'LocalToRemote', 'RemoteToLocal'

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "MigrateMySqlRequest"

type

type: object

className

className: string = "MigrateMySqlRequest"

name

modelProperties

modelProperties: object

connectionString

connectionString: object

required

required: true = true

serializedName

serializedName: string = "properties.connectionString"

type

type: object

name

migrationType

migrationType: object

required

required: true = true

serializedName

serializedName: string = "properties.migrationType"

type

type: object

allowedValues

allowedValues: string[] = ["LocalToRemote","RemoteToLocal"]

name

Const MigrateMySqlStatus

MigrateMySqlStatus: object

interface: An interface representing MigrateMySqlStatus. MySQL migration status.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional localMySqlEnabled

localMySqlEnabled: undefined | false | true

member: {boolean} [localMySqlEnabled] True if the web app has in app MySql enabled NOTE: This property will not be serialized. It can only be populated by the server.

Optional migrationOperationStatus

migrationOperationStatus: OperationStatus

member: {OperationStatus} [migrationOperationStatus] Status of the migration task. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created' NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationId

operationId: undefined | string

member: {string} [operationId] Operation ID for the migration task. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "properties.operationId"

type

type: object

name

Const NameIdentifier

NameIdentifier: object

interface: An interface representing NameIdentifier. Identifies an object.

Optional name

member: {string} [name] Name of the object.

serializedName

serializedName: string = "NameIdentifier"

type

type: object

className

className: string = "NameIdentifier"

name

modelProperties

modelProperties: object

name

serializedName

serializedName: string = "name"

type

type: object

name

Const NameIdentifierCollection

NameIdentifierCollection: object

interface: An interface representing the NameIdentifierCollection. Collection of domain name identifiers.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NameIdentifierCollection"

__@iterator

__@iterator(): IterableIterator<NameIdentifier>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<NameIdentifier>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<NameIdentifier>[]): NameIdentifier[]
concat(...items: (T | ConcatArray<T>)[]): NameIdentifier[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<NameIdentifier>[]
 
 Additional items to add to the end of array1.
Returns NameIdentifier[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns NameIdentifier[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, NameIdentifier]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, NameIdentifier]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: NameIdentifier, index: number, array: NameIdentifier[]): boolean
    - Parameters
      - value: NameIdentifier
      - index: number
      - array: NameIdentifier[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: NameIdentifier, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: NameIdentifier
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): NameIdentifier[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: NameIdentifier
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: NameIdentifier, index: number, array: NameIdentifier[]): boolean
    - Parameters
      - value: NameIdentifier
      - index: number
      - array: NameIdentifier[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: NameIdentifier, index: number, array: NameIdentifier[]): any
    - Parameters
      - value: NameIdentifier
      - index: number
      - array: NameIdentifier[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns NameIdentifier[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): NameIdentifier | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: NameIdentifier
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: NameIdentifier, index: number, obj: NameIdentifier[]): boolean
    - Parameters
      - this: void
      - value: NameIdentifier
      - index: number
      - obj: NameIdentifier[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: NameIdentifier, index: number, obj: NameIdentifier[]): boolean
    - Parameters
      - value: NameIdentifier
      - index: number
      - obj: NameIdentifier[]
      Returns boolean
- Optional thisArg: any
Returns NameIdentifier | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: NameIdentifier, index: number, obj: NameIdentifier[]): boolean
    - Parameters
      - value: NameIdentifier
      - index: number
      - obj: NameIdentifier[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: NameIdentifier, index: number, array: NameIdentifier[]): void
    - Parameters
      - value: NameIdentifier
      - index: number
      - array: NameIdentifier[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: NameIdentifier, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: NameIdentifier
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: NameIdentifier, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: NameIdentifier
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: NameIdentifier, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: NameIdentifier
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: NameIdentifier, index: number, array: NameIdentifier[]): U
    - Parameters
      - value: NameIdentifier
      - index: number
      - array: NameIdentifier[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): NameIdentifier | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns NameIdentifier | undefined

push

push(...items: NameIdentifier[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: NameIdentifier[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): NameIdentifier
reduce(callbackfn: function, initialValue: NameIdentifier): NameIdentifier
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: NameIdentifier, currentValue: NameIdentifier, currentIndex: number, array: NameIdentifier[]): NameIdentifier
    - Parameters
      - previousValue: NameIdentifier
      - currentValue: NameIdentifier
      - currentIndex: number
      - array: NameIdentifier[]
      Returns NameIdentifier
Returns NameIdentifier
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: NameIdentifier, currentValue: NameIdentifier, currentIndex: number, array: NameIdentifier[]): NameIdentifier
    - Parameters
      - previousValue: NameIdentifier
      - currentValue: NameIdentifier
      - currentIndex: number
      - array: NameIdentifier[]
      Returns NameIdentifier
- initialValue: NameIdentifier
Returns NameIdentifier
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: NameIdentifier, currentIndex: number, array: NameIdentifier[]): U
    - Parameters
      - previousValue: U
      - currentValue: NameIdentifier
      - currentIndex: number
      - array: NameIdentifier[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): NameIdentifier
reduceRight(callbackfn: function, initialValue: NameIdentifier): NameIdentifier
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: NameIdentifier, currentValue: NameIdentifier, currentIndex: number, array: NameIdentifier[]): NameIdentifier
    - Parameters
      - previousValue: NameIdentifier
      - currentValue: NameIdentifier
      - currentIndex: number
      - array: NameIdentifier[]
      Returns NameIdentifier
Returns NameIdentifier
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: NameIdentifier, currentValue: NameIdentifier, currentIndex: number, array: NameIdentifier[]): NameIdentifier
    - Parameters
      - previousValue: NameIdentifier
      - currentValue: NameIdentifier
      - currentIndex: number
      - array: NameIdentifier[]
      Returns NameIdentifier
- initialValue: NameIdentifier
Returns NameIdentifier
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: NameIdentifier, currentIndex: number, array: NameIdentifier[]): U
    - Parameters
      - previousValue: U
      - currentValue: NameIdentifier
      - currentIndex: number
      - array: NameIdentifier[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): NameIdentifier[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns NameIdentifier[]

shift

shift(): NameIdentifier | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns NameIdentifier | undefined

slice

slice(start?: undefined | number, end?: undefined | number): NameIdentifier[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns NameIdentifier[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: NameIdentifier, index: number, array: NameIdentifier[]): boolean
    - Parameters
      - value: NameIdentifier
      - index: number
      - array: NameIdentifier[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): NameIdentifier[]
splice(start: number, deleteCount: number, ...items: NameIdentifier[]): NameIdentifier[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns NameIdentifier[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: NameIdentifier[]
  
  Elements to insert into the array in place of the deleted elements.
Returns NameIdentifier[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: NameIdentifier[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: NameIdentifier[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<NameIdentifier>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<NameIdentifier>

type

type: object

className

className: string = "NameIdentifierCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "NameIdentifier"

name

Const NameValuePair

NameValuePair: object

interface: An interface representing NameValuePair. Name value pair.

Optional name

member: {string} [name] Pair name.

serializedName

serializedName: string = "NameValuePair"

Optional value

value: undefined | string

member: {string} [value] Pair value.

type

type: object

className

className: string = "NameValuePair"

name

modelProperties

modelProperties: object

name

serializedName

serializedName: string = "name"

type

type: object

name

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

Const NetworkAccessControlEntry

NetworkAccessControlEntry: object

interface: An interface representing NetworkAccessControlEntry. Network access control entry.

Optional action

action: AccessControlEntryAction

member: {AccessControlEntryAction} [action] Action object. Possible values include: 'Permit', 'Deny'

Optional description

description: undefined | string

member: {string} [description] Description of network access control entry.

Optional order

order: undefined | number

member: {number} [order] Order of precedence.

Optional remoteSubnet

remoteSubnet: undefined | string

member: {string} [remoteSubnet] Remote subnet.

serializedName

serializedName: string = "NetworkAccessControlEntry"

type

type: object

className

className: string = "NetworkAccessControlEntry"

name

modelProperties

modelProperties: object

action

name

Const NetworkFeatures

NetworkFeatures: object

interface: An interface representing NetworkFeatures. Full view of network features for an app (presently VNET integration and Hybrid Connections).
extends: ProxyOnlyResource

Optional hybridConnections

hybridConnections: RelayServiceConnectionEntity[]

member: {RelayServiceConnectionEntity[]} [hybridConnections] The Hybrid Connections summary view. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hybridConnectionsV2

hybridConnectionsV2: HybridConnection[]

member: {HybridConnection[]} [hybridConnectionsV2] The Hybrid Connection V2 (Service Bus) view. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "NetworkFeatures"

Optional virtualNetworkConnection

virtualNetworkConnection: VnetInfo

member: {VnetInfo} [virtualNetworkConnection] The Virtual Network summary view. NOTE: This property will not be serialized. It can only be populated by the server.

Optional virtualNetworkName

virtualNetworkName: undefined | string

member: {string} [virtualNetworkName] The Virtual Network name. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "NetworkFeatures"

name

modelProperties

modelProperties: object

hybridConnections

hybridConnections: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.hybridConnections"

type

type: object

name

element

element: object

type

type: object

className

className: string = "RelayServiceConnectionEntity"

name

Const NetworkTrace

NetworkTrace: object

interface: An interface representing NetworkTrace. Network trace

Optional message

message: undefined | string

member: {string} [message] Detailed message of a network trace operation, e.g. error message in case of failure.

Optional path

path: undefined | string

member: {string} [path] Local file path for the captured network trace file.

serializedName

serializedName: string = "NetworkTrace"

Optional status

status: undefined | string

member: {string} [status] Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed).

type

type: object

className

className: string = "NetworkTrace"

name

modelProperties

name

Const Operation

Operation: object

interface: An interface representing Operation. An operation on a resource.

Optional createdTime

createdTime: Date

member: {Date} [createdTime] Time when operation has started.

Optional errors

errors: ErrorEntity[]

member: {ErrorEntity[]} [errors] Any errors associate with the operation.

Optional expirationTime

expirationTime: Date

member: {Date} [expirationTime] Time when operation will expire.

Optional geoMasterOperationId

geoMasterOperationId: undefined | string

member: {string} [geoMasterOperationId] Applicable only for stamp operation ids.

Optional id

id: undefined | string

member: {string} [id] Operation ID.

Optional modifiedTime

modifiedTime: Date

member: {Date} [modifiedTime] Time when operation has been updated.

Optional name

member: {string} [name] Operation name.

serializedName

serializedName: string = "Operation"

Optional status

status: OperationStatus

member: {OperationStatus} [status] The current status of the operation. Possible values include: 'InProgress', 'Failed', 'Succeeded', 'TimedOut', 'Created'

type

type: object

className

className: string = "Operation"

name

modelProperties

name

name

serializedName

serializedName: string = "name"

type

type: object

name

status

status: object

serializedName

serializedName: string = "status"

type

type: object

allowedValues

allowedValues: string[] = ["InProgress","Failed","Succeeded","TimedOut","Created"]

name

Const PerfMonCounterCollection

PerfMonCounterCollection: object

interface: An interface representing the PerfMonCounterCollection. Collection of performance monitor counters.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PerfMonCounterCollection"

__@iterator

__@iterator(): IterableIterator<PerfMonResponse>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<PerfMonResponse>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<PerfMonResponse>[]): PerfMonResponse[]
concat(...items: (T | ConcatArray<T>)[]): PerfMonResponse[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<PerfMonResponse>[]
 
 Additional items to add to the end of array1.
Returns PerfMonResponse[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns PerfMonResponse[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, PerfMonResponse]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, PerfMonResponse]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: PerfMonResponse, index: number, array: PerfMonResponse[]): boolean
    - Parameters
      - value: PerfMonResponse
      - index: number
      - array: PerfMonResponse[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: PerfMonResponse, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: PerfMonResponse
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): PerfMonResponse[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: PerfMonResponse
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: PerfMonResponse, index: number, array: PerfMonResponse[]): boolean
    - Parameters
      - value: PerfMonResponse
      - index: number
      - array: PerfMonResponse[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: PerfMonResponse, index: number, array: PerfMonResponse[]): any
    - Parameters
      - value: PerfMonResponse
      - index: number
      - array: PerfMonResponse[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns PerfMonResponse[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): PerfMonResponse | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: PerfMonResponse
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: PerfMonResponse, index: number, obj: PerfMonResponse[]): boolean
    - Parameters
      - this: void
      - value: PerfMonResponse
      - index: number
      - obj: PerfMonResponse[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: PerfMonResponse, index: number, obj: PerfMonResponse[]): boolean
    - Parameters
      - value: PerfMonResponse
      - index: number
      - obj: PerfMonResponse[]
      Returns boolean
- Optional thisArg: any
Returns PerfMonResponse | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: PerfMonResponse, index: number, obj: PerfMonResponse[]): boolean
    - Parameters
      - value: PerfMonResponse
      - index: number
      - obj: PerfMonResponse[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: PerfMonResponse, index: number, array: PerfMonResponse[]): void
    - Parameters
      - value: PerfMonResponse
      - index: number
      - array: PerfMonResponse[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: PerfMonResponse, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: PerfMonResponse
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: PerfMonResponse, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: PerfMonResponse
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: PerfMonResponse, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: PerfMonResponse
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: PerfMonResponse, index: number, array: PerfMonResponse[]): U
    - Parameters
      - value: PerfMonResponse
      - index: number
      - array: PerfMonResponse[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): PerfMonResponse | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns PerfMonResponse | undefined

push

push(...items: PerfMonResponse[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: PerfMonResponse[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): PerfMonResponse
reduce(callbackfn: function, initialValue: PerfMonResponse): PerfMonResponse
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: PerfMonResponse, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): PerfMonResponse
    - Parameters
      - previousValue: PerfMonResponse
      - currentValue: PerfMonResponse
      - currentIndex: number
      - array: PerfMonResponse[]
      Returns PerfMonResponse
Returns PerfMonResponse
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: PerfMonResponse, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): PerfMonResponse
    - Parameters
      - previousValue: PerfMonResponse
      - currentValue: PerfMonResponse
      - currentIndex: number
      - array: PerfMonResponse[]
      Returns PerfMonResponse
- initialValue: PerfMonResponse
Returns PerfMonResponse
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): U
    - Parameters
      - previousValue: U
      - currentValue: PerfMonResponse
      - currentIndex: number
      - array: PerfMonResponse[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): PerfMonResponse
reduceRight(callbackfn: function, initialValue: PerfMonResponse): PerfMonResponse
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: PerfMonResponse, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): PerfMonResponse
    - Parameters
      - previousValue: PerfMonResponse
      - currentValue: PerfMonResponse
      - currentIndex: number
      - array: PerfMonResponse[]
      Returns PerfMonResponse
Returns PerfMonResponse
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: PerfMonResponse, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): PerfMonResponse
    - Parameters
      - previousValue: PerfMonResponse
      - currentValue: PerfMonResponse
      - currentIndex: number
      - array: PerfMonResponse[]
      Returns PerfMonResponse
- initialValue: PerfMonResponse
Returns PerfMonResponse
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: PerfMonResponse, currentIndex: number, array: PerfMonResponse[]): U
    - Parameters
      - previousValue: U
      - currentValue: PerfMonResponse
      - currentIndex: number
      - array: PerfMonResponse[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): PerfMonResponse[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns PerfMonResponse[]

shift

shift(): PerfMonResponse | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns PerfMonResponse | undefined

slice

slice(start?: undefined | number, end?: undefined | number): PerfMonResponse[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns PerfMonResponse[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: PerfMonResponse, index: number, array: PerfMonResponse[]): boolean
    - Parameters
      - value: PerfMonResponse
      - index: number
      - array: PerfMonResponse[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): PerfMonResponse[]
splice(start: number, deleteCount: number, ...items: PerfMonResponse[]): PerfMonResponse[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns PerfMonResponse[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: PerfMonResponse[]
  
  Elements to insert into the array in place of the deleted elements.
Returns PerfMonResponse[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: PerfMonResponse[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: PerfMonResponse[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<PerfMonResponse>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<PerfMonResponse>

type

type: object

className

className: string = "PerfMonCounterCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "PerfMonResponse"

name

Const PerfMonResponse

PerfMonResponse: object

interface: An interface representing PerfMonResponse. Performance monitor API response.

Optional code

code: undefined | string

member: {string} [code] The response code.

Optional data

data: PerfMonSet

member: {PerfMonSet} [data] The performance monitor counters.

Optional message

message: undefined | string

member: {string} [message] The message.

serializedName

serializedName: string = "message"

type

type: object

name

Const PerfMonSample

PerfMonSample: object

interface: An interface representing PerfMonSample. Performance monitor sample in a set.

Optional instanceName

instanceName: undefined | string

member: {string} [instanceName] Name of the server on which the measurement is made.

serializedName

serializedName: string = "PerfMonSample"

Optional time

time: Date

member: {Date} [time] Point in time for which counter was measured.

Optional value

value: undefined | number

member: {number} [value] Value of counter at a certain time.

type

type: object

className

className: string = "PerfMonSample"

name

modelProperties

name

Const PerfMonSet

PerfMonSet: object

interface: An interface representing PerfMonSet. Metric information.

Optional endTime

endTime: Date

member: {Date} [endTime] End time of the period.

Optional name

member: {string} [name] Unique key name of the counter.

serializedName

serializedName: string = "PerfMonSet"

Optional startTime

startTime: Date

member: {Date} [startTime] Start time of the period.

Optional timeGrain

timeGrain: undefined | string

member: {string} [timeGrain] Presented time grain.

Optional values

values: PerfMonSample[]

member: {PerfMonSample[]} [values] Collection of workers that are active during this time.

type

type: object

className

className: string = "PerfMonSet"

name

modelProperties

modelProperties: object

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

Const PremierAddOn

PremierAddOn: object

interface: An interface representing PremierAddOn. Premier add-on.
extends: Resource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

location

location: string

member: {string} location Resource Location.

Optional marketplaceOffer

marketplaceOffer: undefined | string

member: {string} [marketplaceOffer] Premier add on Marketplace offer.

Optional marketplacePublisher

marketplacePublisher: undefined | string

member: {string} [marketplacePublisher] Premier add on Marketplace publisher.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional product

product: undefined | string

member: {string} [product] Premier add on Product.

serializedName

serializedName: string = "PremierAddOn"

Optional sku

sku: undefined | string

member: {string} [sku] Premier add on SKU.

Optional tags

tags: undefined | object

member: {{ [propertyName: string]: string }} [tags] Resource tags.

Optional vendor

vendor: undefined | string

member: {string} [vendor] Premier add on Vendor.

type

type: object

className

className: string = "PremierAddOn"

name

modelProperties

name

Const PremierAddOnOffer

PremierAddOnOffer: object

interface: An interface representing PremierAddOnOffer. Premier add-on offer.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional legalTermsUrl

legalTermsUrl: undefined | string

member: {string} [legalTermsUrl] Legal terms URL.

Optional marketplaceOffer

marketplaceOffer: undefined | string

member: {string} [marketplaceOffer] Marketplace offer.

Optional marketplacePublisher

marketplacePublisher: undefined | string

member: {string} [marketplacePublisher] Marketplace publisher.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privacyPolicyUrl

privacyPolicyUrl: undefined | string

member: {string} [privacyPolicyUrl] Privacy policy URL.

Optional product

product: undefined | string

member: {string} [product] Premier add on offer Product.

Optional promoCodeRequired

promoCodeRequired: undefined | false | true

member: {boolean} [promoCodeRequired] true if promotion code is required; otherwise, false.

Optional quota

quota: undefined | number

member: {number} [quota] Premier add on offer Quota.

serializedName

serializedName: string = "PremierAddOnOffer"

Optional sku

sku: undefined | string

member: {string} [sku] Premier add on SKU.

Optional vendor

vendor: undefined | string

member: {string} [vendor] Premier add on offer Vendor.

Optional webHostingPlanRestrictions

webHostingPlanRestrictions: AppServicePlanRestrictions

member: {AppServicePlanRestrictions} [webHostingPlanRestrictions] App Service plans this offer is restricted to. Possible values include: 'None', 'Free', 'Shared', 'Basic', 'Standard', 'Premium'

type

type: object

className

className: string = "PremierAddOnOffer"

name

modelProperties

allowedValues

allowedValues: string[] = ["None","Free","Shared","Basic","Standard","Premium"]

name

Const PremierAddOnOfferCollection

PremierAddOnOfferCollection: object

interface: An interface representing the PremierAddOnOfferCollection. Collection of premier add-on offers.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PremierAddOnOfferCollection"

__@iterator

__@iterator(): IterableIterator<PremierAddOnOffer>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<PremierAddOnOffer>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<PremierAddOnOffer>[]): PremierAddOnOffer[]
concat(...items: (T | ConcatArray<T>)[]): PremierAddOnOffer[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<PremierAddOnOffer>[]
 
 Additional items to add to the end of array1.
Returns PremierAddOnOffer[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns PremierAddOnOffer[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, PremierAddOnOffer]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, PremierAddOnOffer]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): boolean
    - Parameters
      - value: PremierAddOnOffer
      - index: number
      - array: PremierAddOnOffer[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: PremierAddOnOffer, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: PremierAddOnOffer
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): PremierAddOnOffer[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: PremierAddOnOffer
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): boolean
    - Parameters
      - value: PremierAddOnOffer
      - index: number
      - array: PremierAddOnOffer[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): any
    - Parameters
      - value: PremierAddOnOffer
      - index: number
      - array: PremierAddOnOffer[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns PremierAddOnOffer[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): PremierAddOnOffer | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: PremierAddOnOffer
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: PremierAddOnOffer, index: number, obj: PremierAddOnOffer[]): boolean
    - Parameters
      - this: void
      - value: PremierAddOnOffer
      - index: number
      - obj: PremierAddOnOffer[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: PremierAddOnOffer, index: number, obj: PremierAddOnOffer[]): boolean
    - Parameters
      - value: PremierAddOnOffer
      - index: number
      - obj: PremierAddOnOffer[]
      Returns boolean
- Optional thisArg: any
Returns PremierAddOnOffer | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: PremierAddOnOffer, index: number, obj: PremierAddOnOffer[]): boolean
    - Parameters
      - value: PremierAddOnOffer
      - index: number
      - obj: PremierAddOnOffer[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): void
    - Parameters
      - value: PremierAddOnOffer
      - index: number
      - array: PremierAddOnOffer[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: PremierAddOnOffer, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: PremierAddOnOffer
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: PremierAddOnOffer, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: PremierAddOnOffer
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: PremierAddOnOffer, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: PremierAddOnOffer
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): U
    - Parameters
      - value: PremierAddOnOffer
      - index: number
      - array: PremierAddOnOffer[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): PremierAddOnOffer | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns PremierAddOnOffer | undefined

push

push(...items: PremierAddOnOffer[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: PremierAddOnOffer[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): PremierAddOnOffer
reduce(callbackfn: function, initialValue: PremierAddOnOffer): PremierAddOnOffer
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: PremierAddOnOffer, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): PremierAddOnOffer
    - Parameters
      - previousValue: PremierAddOnOffer
      - currentValue: PremierAddOnOffer
      - currentIndex: number
      - array: PremierAddOnOffer[]
      Returns PremierAddOnOffer
Returns PremierAddOnOffer
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: PremierAddOnOffer, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): PremierAddOnOffer
    - Parameters
      - previousValue: PremierAddOnOffer
      - currentValue: PremierAddOnOffer
      - currentIndex: number
      - array: PremierAddOnOffer[]
      Returns PremierAddOnOffer
- initialValue: PremierAddOnOffer
Returns PremierAddOnOffer
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): U
    - Parameters
      - previousValue: U
      - currentValue: PremierAddOnOffer
      - currentIndex: number
      - array: PremierAddOnOffer[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): PremierAddOnOffer
reduceRight(callbackfn: function, initialValue: PremierAddOnOffer): PremierAddOnOffer
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: PremierAddOnOffer, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): PremierAddOnOffer
    - Parameters
      - previousValue: PremierAddOnOffer
      - currentValue: PremierAddOnOffer
      - currentIndex: number
      - array: PremierAddOnOffer[]
      Returns PremierAddOnOffer
Returns PremierAddOnOffer
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: PremierAddOnOffer, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): PremierAddOnOffer
    - Parameters
      - previousValue: PremierAddOnOffer
      - currentValue: PremierAddOnOffer
      - currentIndex: number
      - array: PremierAddOnOffer[]
      Returns PremierAddOnOffer
- initialValue: PremierAddOnOffer
Returns PremierAddOnOffer
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: PremierAddOnOffer, currentIndex: number, array: PremierAddOnOffer[]): U
    - Parameters
      - previousValue: U
      - currentValue: PremierAddOnOffer
      - currentIndex: number
      - array: PremierAddOnOffer[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): PremierAddOnOffer[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns PremierAddOnOffer[]

shift

shift(): PremierAddOnOffer | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns PremierAddOnOffer | undefined

slice

slice(start?: undefined | number, end?: undefined | number): PremierAddOnOffer[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns PremierAddOnOffer[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: PremierAddOnOffer, index: number, array: PremierAddOnOffer[]): boolean
    - Parameters
      - value: PremierAddOnOffer
      - index: number
      - array: PremierAddOnOffer[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): PremierAddOnOffer[]
splice(start: number, deleteCount: number, ...items: PremierAddOnOffer[]): PremierAddOnOffer[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns PremierAddOnOffer[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: PremierAddOnOffer[]
  
  Elements to insert into the array in place of the deleted elements.
Returns PremierAddOnOffer[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: PremierAddOnOffer[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: PremierAddOnOffer[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<PremierAddOnOffer>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<PremierAddOnOffer>

type

type: object

className

className: string = "PremierAddOnOfferCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "PremierAddOnOffer"

name

Const PremierAddOnPatchResource

PremierAddOnPatchResource: object

interface: An interface representing PremierAddOnPatchResource. ARM resource for a PremierAddOn.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional marketplaceOffer

marketplaceOffer: undefined | string

member: {string} [marketplaceOffer] Premier add on Marketplace offer.

Optional marketplacePublisher

marketplacePublisher: undefined | string

member: {string} [marketplacePublisher] Premier add on Marketplace publisher.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional product

product: undefined | string

member: {string} [product] Premier add on Product.

serializedName

serializedName: string = "PremierAddOnPatchResource"

Optional sku

sku: undefined | string

member: {string} [sku] Premier add on SKU.

Optional vendor

vendor: undefined | string

member: {string} [vendor] Premier add on Vendor.

type

type: object

className

className: string = "PremierAddOnPatchResource"

name

modelProperties

name

Const PrivateAccess

PrivateAccess: object

interface: An interface representing PrivateAccess. Description of the parameters of Private Access for a Web Site.
extends: ProxyOnlyResource

Optional enabled

enabled: undefined | false | true

member: {boolean} [enabled] Whether private access is enabled or not.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PrivateAccess"

Optional virtualNetworks

virtualNetworks: PrivateAccessVirtualNetwork[]

member: {PrivateAccessVirtualNetwork[]} [virtualNetworks] The Virtual Networks (and subnets) allowed to access the site privately.

type

type: object

className

className: string = "PrivateAccess"

name

modelProperties

name

Const PrivateAccessSubnet

PrivateAccessSubnet: object

interface: An interface representing PrivateAccessSubnet. Description of a Virtual Network subnet that is useable for private site access.

Optional key

key: undefined | number

member: {number} [key] The key (ID) of the subnet.

Optional name

member: {string} [name] The name of the subnet.

serializedName

serializedName: string = "PrivateAccessSubnet"

type

type: object

className

className: string = "PrivateAccessSubnet"

name

modelProperties

modelProperties: object

key

key: object

serializedName

serializedName: string = "key"

type

type: object

name

name

serializedName

serializedName: string = "name"

type

type: object

name

Const PrivateAccessVirtualNetwork

PrivateAccessVirtualNetwork: object

interface: An interface representing PrivateAccessVirtualNetwork. Description of a Virtual Network that is useable for private site access.

Optional key

key: undefined | number

member: {number} [key] The key (ID) of the Virtual Network.

Optional name

member: {string} [name] The name of the Virtual Network.

Optional resourceId

resourceId: undefined | string

member: {string} [resourceId] The ARM uri of the Virtual Network

serializedName

serializedName: string = "PrivateAccessVirtualNetwork"

Optional subnets

subnets: PrivateAccessSubnet[]

member: {PrivateAccessSubnet[]} [subnets] A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.

type

type: object

className

className: string = "PrivateAccessVirtualNetwork"

name

modelProperties

modelProperties: object

key

key: object

serializedName

serializedName: string = "key"

type

type: object

Const ProcessInfo

ProcessInfo: object

interface: An interface representing ProcessInfo. Process Information.
extends: ProxyOnlyResource

Optional children

children: string[]

member: {string[]} [children] Child process list.

Optional commandLine

commandLine: undefined | string

member: {string} [commandLine] Command line.

Optional deploymentName

deploymentName: undefined | string

member: {string} [deploymentName] Deployment name.

Optional description

description: undefined | string

member: {string} [description] Description of process.

Optional environmentVariables

environmentVariables: undefined | object

member: {{ [propertyName: string]: string }} [environmentVariables] List of environment variables.

Optional fileName

fileName: undefined | string

member: {string} [fileName] File name of this process.

Optional handleCount

handleCount: undefined | number

member: {number} [handleCount] Handle count.

Optional href

href: undefined | string

member: {string} [href] HRef URI.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identifier

identifier: undefined | number

member: {number} [identifier] ARM Identifier for deployment. NOTE: This property will not be serialized. It can only be populated by the server.

Optional iisProfileTimeoutInSeconds

iisProfileTimeoutInSeconds: undefined | number

member: {number} [iisProfileTimeoutInSeconds] IIS Profile timeout (seconds).

Optional isIisProfileRunning

isIisProfileRunning: undefined | false | true

member: {boolean} [isIisProfileRunning] Is the IIS Profile running?

Optional isProfileRunning

isProfileRunning: undefined | false | true

member: {boolean} [isProfileRunning] Is profile running?

Optional isScmSite

isScmSite: undefined | false | true

member: {boolean} [isScmSite] Is this the SCM site?

Optional isWebjob

isWebjob: undefined | false | true

member: {boolean} [isWebjob] Is this a Web Job?

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional minidump

minidump: undefined | string

member: {string} [minidump] Minidump URI.

Optional moduleCount

moduleCount: undefined | number

member: {number} [moduleCount] Module count.

Optional modules

modules: ProcessModuleInfo[]

member: {ProcessModuleInfo[]} [modules] List of modules.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nonPagedSystemMemory

nonPagedSystemMemory: undefined | number

member: {number} [nonPagedSystemMemory] Non-paged system memory.

Optional openFileHandles

openFileHandles: string[]

member: {string[]} [openFileHandles] List of open files.

Optional pagedMemory

pagedMemory: undefined | number

member: {number} [pagedMemory] Paged memory.

Optional pagedSystemMemory

pagedSystemMemory: undefined | number

member: {number} [pagedSystemMemory] Paged system memory.

Optional parent

parent: undefined | string

member: {string} [parent] Parent process.

Optional peakPagedMemory

peakPagedMemory: undefined | number

member: {number} [peakPagedMemory] Peak paged memory.

Optional peakVirtualMemory

peakVirtualMemory: undefined | number

member: {number} [peakVirtualMemory] Peak virtual memory usage.

Optional peakWorkingSet

peakWorkingSet: undefined | number

member: {number} [peakWorkingSet] Peak working set.

Optional privateMemory

privateMemory: undefined | number

member: {number} [privateMemory] Private memory size.

Optional privilegedCpuTime

privilegedCpuTime: undefined | string

member: {string} [privilegedCpuTime] Privileged CPU time.

serializedName

serializedName: string = "ProcessInfo"

Optional startTime

startTime: Date

member: {Date} [startTime] Start time.

Optional threadCount

threadCount: undefined | number

member: {number} [threadCount] Thread count.

Optional threads

threads: ProcessThreadInfo[]

member: {ProcessThreadInfo[]} [threads] Thread list.

Optional timeStamp

timeStamp: Date

member: {Date} [timeStamp] Time stamp.

Optional totalCpuTime

totalCpuTime: undefined | string

member: {string} [totalCpuTime] Total CPU time.

Optional userCpuTime

userCpuTime: undefined | string

member: {string} [userCpuTime] User CPU time.

Optional userName

userName: undefined | string

member: {string} [userName] User name.

Optional virtualMemory

virtualMemory: undefined | number

member: {number} [virtualMemory] Virtual memory size.

Optional workingSet

workingSet: undefined | number

member: {number} [workingSet] Working set.

type

type: object

className

className: string = "ProcessInfo"

name

modelProperties

modelProperties: object

children

children: object

serializedName

serializedName: string = "properties.children"

type

type: object

ProcessInfoCollection: object

interface: An interface representing the ProcessInfoCollection. Collection of Kudu process information elements.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProcessInfoCollection"

__@iterator

__@iterator(): IterableIterator<ProcessInfo>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<ProcessInfo>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<ProcessInfo>[]): ProcessInfo[]
concat(...items: (T | ConcatArray<T>)[]): ProcessInfo[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<ProcessInfo>[]
 
 Additional items to add to the end of array1.
Returns ProcessInfo[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns ProcessInfo[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, ProcessInfo]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, ProcessInfo]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: ProcessInfo, index: number, array: ProcessInfo[]): boolean
    - Parameters
      - value: ProcessInfo
      - index: number
      - array: ProcessInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: ProcessInfo, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: ProcessInfo
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): ProcessInfo[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: ProcessInfo
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ProcessInfo, index: number, array: ProcessInfo[]): boolean
    - Parameters
      - value: ProcessInfo
      - index: number
      - array: ProcessInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ProcessInfo, index: number, array: ProcessInfo[]): any
    - Parameters
      - value: ProcessInfo
      - index: number
      - array: ProcessInfo[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns ProcessInfo[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): ProcessInfo | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: ProcessInfo
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: ProcessInfo, index: number, obj: ProcessInfo[]): boolean
    - Parameters
      - this: void
      - value: ProcessInfo
      - index: number
      - obj: ProcessInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: ProcessInfo, index: number, obj: ProcessInfo[]): boolean
    - Parameters
      - value: ProcessInfo
      - index: number
      - obj: ProcessInfo[]
      Returns boolean
- Optional thisArg: any
Returns ProcessInfo | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: ProcessInfo, index: number, obj: ProcessInfo[]): boolean
    - Parameters
      - value: ProcessInfo
      - index: number
      - obj: ProcessInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: ProcessInfo, index: number, array: ProcessInfo[]): void
    - Parameters
      - value: ProcessInfo
      - index: number
      - array: ProcessInfo[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: ProcessInfo, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: ProcessInfo
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: ProcessInfo, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: ProcessInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: ProcessInfo, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: ProcessInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: ProcessInfo, index: number, array: ProcessInfo[]): U
    - Parameters
      - value: ProcessInfo
      - index: number
      - array: ProcessInfo[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): ProcessInfo | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns ProcessInfo | undefined

push

push(...items: ProcessInfo[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: ProcessInfo[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): ProcessInfo
reduce(callbackfn: function, initialValue: ProcessInfo): ProcessInfo
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ProcessInfo, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): ProcessInfo
    - Parameters
      - previousValue: ProcessInfo
      - currentValue: ProcessInfo
      - currentIndex: number
      - array: ProcessInfo[]
      Returns ProcessInfo
Returns ProcessInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: ProcessInfo, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): ProcessInfo
    - Parameters
      - previousValue: ProcessInfo
      - currentValue: ProcessInfo
      - currentIndex: number
      - array: ProcessInfo[]
      Returns ProcessInfo
- initialValue: ProcessInfo
Returns ProcessInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: ProcessInfo
      - currentIndex: number
      - array: ProcessInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): ProcessInfo
reduceRight(callbackfn: function, initialValue: ProcessInfo): ProcessInfo
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ProcessInfo, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): ProcessInfo
    - Parameters
      - previousValue: ProcessInfo
      - currentValue: ProcessInfo
      - currentIndex: number
      - array: ProcessInfo[]
      Returns ProcessInfo
Returns ProcessInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: ProcessInfo, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): ProcessInfo
    - Parameters
      - previousValue: ProcessInfo
      - currentValue: ProcessInfo
      - currentIndex: number
      - array: ProcessInfo[]
      Returns ProcessInfo
- initialValue: ProcessInfo
Returns ProcessInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ProcessInfo, currentIndex: number, array: ProcessInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: ProcessInfo
      - currentIndex: number
      - array: ProcessInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): ProcessInfo[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns ProcessInfo[]

shift

shift(): ProcessInfo | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns ProcessInfo | undefined

slice

slice(start?: undefined | number, end?: undefined | number): ProcessInfo[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns ProcessInfo[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: ProcessInfo, index: number, array: ProcessInfo[]): boolean
    - Parameters
      - value: ProcessInfo
      - index: number
      - array: ProcessInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): ProcessInfo[]
splice(start: number, deleteCount: number, ...items: ProcessInfo[]): ProcessInfo[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns ProcessInfo[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: ProcessInfo[]
  
  Elements to insert into the array in place of the deleted elements.
Returns ProcessInfo[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: ProcessInfo[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: ProcessInfo[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<ProcessInfo>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<ProcessInfo>

type

type: object

className

className: string = "ProcessInfoCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "ProcessInfo"

name

Const ProcessModuleInfo

ProcessModuleInfo: object

interface: An interface representing ProcessModuleInfo. Process Module Information.
extends: ProxyOnlyResource

Optional baseAddress

baseAddress: undefined | string

member: {string} [baseAddress] Base address. Used as module identifier in ARM resource URI.

Optional fileDescription

fileDescription: undefined | string

member: {string} [fileDescription] File description.

Optional fileName

fileName: undefined | string

member: {string} [fileName] File name.

Optional filePath

filePath: undefined | string

member: {string} [filePath] File path.

Optional fileVersion

fileVersion: undefined | string

member: {string} [fileVersion] File version.

Optional href

href: undefined | string

member: {string} [href] HRef URI.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isDebug

isDebug: undefined | false | true

member: {boolean} [isDebug] Is debug?

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional language

language: undefined | string

member: {string} [language] Module language (locale).

Optional moduleMemorySize

moduleMemorySize: undefined | number

member: {number} [moduleMemorySize] Module memory size.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional product

product: undefined | string

member: {string} [product] Product name.

Optional productVersion

productVersion: undefined | string

member: {string} [productVersion] Product version.

serializedName

serializedName: string = "ProcessModuleInfo"

type

type: object

className

className: string = "ProcessModuleInfo"

name

modelProperties

name

Const ProcessModuleInfoCollection

ProcessModuleInfoCollection: object

interface: An interface representing the ProcessModuleInfoCollection. Collection of Kudu thread information elements.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProcessModuleInfoCollection"

__@iterator

__@iterator(): IterableIterator<ProcessModuleInfo>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<ProcessModuleInfo>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<ProcessModuleInfo>[]): ProcessModuleInfo[]
concat(...items: (T | ConcatArray<T>)[]): ProcessModuleInfo[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<ProcessModuleInfo>[]
 
 Additional items to add to the end of array1.
Returns ProcessModuleInfo[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns ProcessModuleInfo[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, ProcessModuleInfo]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, ProcessModuleInfo]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): boolean
    - Parameters
      - value: ProcessModuleInfo
      - index: number
      - array: ProcessModuleInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: ProcessModuleInfo, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: ProcessModuleInfo
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): ProcessModuleInfo[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: ProcessModuleInfo
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): boolean
    - Parameters
      - value: ProcessModuleInfo
      - index: number
      - array: ProcessModuleInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): any
    - Parameters
      - value: ProcessModuleInfo
      - index: number
      - array: ProcessModuleInfo[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns ProcessModuleInfo[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): ProcessModuleInfo | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: ProcessModuleInfo
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: ProcessModuleInfo, index: number, obj: ProcessModuleInfo[]): boolean
    - Parameters
      - this: void
      - value: ProcessModuleInfo
      - index: number
      - obj: ProcessModuleInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: ProcessModuleInfo, index: number, obj: ProcessModuleInfo[]): boolean
    - Parameters
      - value: ProcessModuleInfo
      - index: number
      - obj: ProcessModuleInfo[]
      Returns boolean
- Optional thisArg: any
Returns ProcessModuleInfo | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: ProcessModuleInfo, index: number, obj: ProcessModuleInfo[]): boolean
    - Parameters
      - value: ProcessModuleInfo
      - index: number
      - obj: ProcessModuleInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): void
    - Parameters
      - value: ProcessModuleInfo
      - index: number
      - array: ProcessModuleInfo[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: ProcessModuleInfo, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: ProcessModuleInfo
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: ProcessModuleInfo, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: ProcessModuleInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: ProcessModuleInfo, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: ProcessModuleInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): U
    - Parameters
      - value: ProcessModuleInfo
      - index: number
      - array: ProcessModuleInfo[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): ProcessModuleInfo | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns ProcessModuleInfo | undefined

push

push(...items: ProcessModuleInfo[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: ProcessModuleInfo[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): ProcessModuleInfo
reduce(callbackfn: function, initialValue: ProcessModuleInfo): ProcessModuleInfo
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ProcessModuleInfo, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): ProcessModuleInfo
    - Parameters
      - previousValue: ProcessModuleInfo
      - currentValue: ProcessModuleInfo
      - currentIndex: number
      - array: ProcessModuleInfo[]
      Returns ProcessModuleInfo
Returns ProcessModuleInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: ProcessModuleInfo, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): ProcessModuleInfo
    - Parameters
      - previousValue: ProcessModuleInfo
      - currentValue: ProcessModuleInfo
      - currentIndex: number
      - array: ProcessModuleInfo[]
      Returns ProcessModuleInfo
- initialValue: ProcessModuleInfo
Returns ProcessModuleInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: ProcessModuleInfo
      - currentIndex: number
      - array: ProcessModuleInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): ProcessModuleInfo
reduceRight(callbackfn: function, initialValue: ProcessModuleInfo): ProcessModuleInfo
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ProcessModuleInfo, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): ProcessModuleInfo
    - Parameters
      - previousValue: ProcessModuleInfo
      - currentValue: ProcessModuleInfo
      - currentIndex: number
      - array: ProcessModuleInfo[]
      Returns ProcessModuleInfo
Returns ProcessModuleInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: ProcessModuleInfo, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): ProcessModuleInfo
    - Parameters
      - previousValue: ProcessModuleInfo
      - currentValue: ProcessModuleInfo
      - currentIndex: number
      - array: ProcessModuleInfo[]
      Returns ProcessModuleInfo
- initialValue: ProcessModuleInfo
Returns ProcessModuleInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ProcessModuleInfo, currentIndex: number, array: ProcessModuleInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: ProcessModuleInfo
      - currentIndex: number
      - array: ProcessModuleInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): ProcessModuleInfo[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns ProcessModuleInfo[]

shift

shift(): ProcessModuleInfo | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns ProcessModuleInfo | undefined

slice

slice(start?: undefined | number, end?: undefined | number): ProcessModuleInfo[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns ProcessModuleInfo[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: ProcessModuleInfo, index: number, array: ProcessModuleInfo[]): boolean
    - Parameters
      - value: ProcessModuleInfo
      - index: number
      - array: ProcessModuleInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): ProcessModuleInfo[]
splice(start: number, deleteCount: number, ...items: ProcessModuleInfo[]): ProcessModuleInfo[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns ProcessModuleInfo[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: ProcessModuleInfo[]
  
  Elements to insert into the array in place of the deleted elements.
Returns ProcessModuleInfo[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: ProcessModuleInfo[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: ProcessModuleInfo[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<ProcessModuleInfo>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<ProcessModuleInfo>

type

type: object

className

className: string = "ProcessModuleInfoCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "ProcessModuleInfo"

name

Const ProcessThreadInfo

ProcessThreadInfo: object

interface: An interface representing ProcessThreadInfo. Process Thread Information.
extends: ProxyOnlyResource

Optional basePriority

basePriority: undefined | number

member: {number} [basePriority] Base priority.

Optional currentPriority

currentPriority: undefined | number

member: {number} [currentPriority] Current thread priority.

Optional href

href: undefined | string

member: {string} [href] HRef URI.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identifier

identifier: undefined | number

member: {number} [identifier] Site extension ID. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional priorityLevel

priorityLevel: undefined | string

member: {string} [priorityLevel] Thread priority level.

Optional priviledgedProcessorTime

priviledgedProcessorTime: undefined | string

member: {string} [priviledgedProcessorTime] Priviledged processor time.

Optional process

process: undefined | string

member: {string} [process] Process URI.

serializedName

serializedName: string = "ProcessThreadInfo"

Optional startAddress

startAddress: undefined | string

member: {string} [startAddress] Start address.

Optional startTime

startTime: Date

member: {Date} [startTime] Start time.

Optional state

state: undefined | string

member: {string} [state] Thread state.

Optional totalProcessorTime

totalProcessorTime: undefined | string

member: {string} [totalProcessorTime] Total processor time.

Optional userProcessorTime

userProcessorTime: undefined | string

member: {string} [userProcessorTime] User processor time.

Optional waitReason

waitReason: undefined | string

member: {string} [waitReason] Wait reason.

type

type: object

className

className: string = "ProcessThreadInfo"

name

modelProperties

name

Const ProcessThreadInfoCollection

ProcessThreadInfoCollection: object

interface: An interface representing the ProcessThreadInfoCollection. Collection of Kudu thread information elements.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProcessThreadInfoCollection"

__@iterator

__@iterator(): IterableIterator<ProcessThreadInfo>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<ProcessThreadInfo>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<ProcessThreadInfo>[]): ProcessThreadInfo[]
concat(...items: (T | ConcatArray<T>)[]): ProcessThreadInfo[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<ProcessThreadInfo>[]
 
 Additional items to add to the end of array1.
Returns ProcessThreadInfo[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns ProcessThreadInfo[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, ProcessThreadInfo]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, ProcessThreadInfo]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): boolean
    - Parameters
      - value: ProcessThreadInfo
      - index: number
      - array: ProcessThreadInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: ProcessThreadInfo, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: ProcessThreadInfo
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): ProcessThreadInfo[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: ProcessThreadInfo
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): boolean
    - Parameters
      - value: ProcessThreadInfo
      - index: number
      - array: ProcessThreadInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): any
    - Parameters
      - value: ProcessThreadInfo
      - index: number
      - array: ProcessThreadInfo[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns ProcessThreadInfo[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): ProcessThreadInfo | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: ProcessThreadInfo
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: ProcessThreadInfo, index: number, obj: ProcessThreadInfo[]): boolean
    - Parameters
      - this: void
      - value: ProcessThreadInfo
      - index: number
      - obj: ProcessThreadInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: ProcessThreadInfo, index: number, obj: ProcessThreadInfo[]): boolean
    - Parameters
      - value: ProcessThreadInfo
      - index: number
      - obj: ProcessThreadInfo[]
      Returns boolean
- Optional thisArg: any
Returns ProcessThreadInfo | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: ProcessThreadInfo, index: number, obj: ProcessThreadInfo[]): boolean
    - Parameters
      - value: ProcessThreadInfo
      - index: number
      - obj: ProcessThreadInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): void
    - Parameters
      - value: ProcessThreadInfo
      - index: number
      - array: ProcessThreadInfo[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: ProcessThreadInfo, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: ProcessThreadInfo
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: ProcessThreadInfo, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: ProcessThreadInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: ProcessThreadInfo, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: ProcessThreadInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): U
    - Parameters
      - value: ProcessThreadInfo
      - index: number
      - array: ProcessThreadInfo[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): ProcessThreadInfo | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns ProcessThreadInfo | undefined

push

push(...items: ProcessThreadInfo[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: ProcessThreadInfo[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): ProcessThreadInfo
reduce(callbackfn: function, initialValue: ProcessThreadInfo): ProcessThreadInfo
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ProcessThreadInfo, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): ProcessThreadInfo
    - Parameters
      - previousValue: ProcessThreadInfo
      - currentValue: ProcessThreadInfo
      - currentIndex: number
      - array: ProcessThreadInfo[]
      Returns ProcessThreadInfo
Returns ProcessThreadInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: ProcessThreadInfo, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): ProcessThreadInfo
    - Parameters
      - previousValue: ProcessThreadInfo
      - currentValue: ProcessThreadInfo
      - currentIndex: number
      - array: ProcessThreadInfo[]
      Returns ProcessThreadInfo
- initialValue: ProcessThreadInfo
Returns ProcessThreadInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: ProcessThreadInfo
      - currentIndex: number
      - array: ProcessThreadInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): ProcessThreadInfo
reduceRight(callbackfn: function, initialValue: ProcessThreadInfo): ProcessThreadInfo
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ProcessThreadInfo, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): ProcessThreadInfo
    - Parameters
      - previousValue: ProcessThreadInfo
      - currentValue: ProcessThreadInfo
      - currentIndex: number
      - array: ProcessThreadInfo[]
      Returns ProcessThreadInfo
Returns ProcessThreadInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: ProcessThreadInfo, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): ProcessThreadInfo
    - Parameters
      - previousValue: ProcessThreadInfo
      - currentValue: ProcessThreadInfo
      - currentIndex: number
      - array: ProcessThreadInfo[]
      Returns ProcessThreadInfo
- initialValue: ProcessThreadInfo
Returns ProcessThreadInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ProcessThreadInfo, currentIndex: number, array: ProcessThreadInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: ProcessThreadInfo
      - currentIndex: number
      - array: ProcessThreadInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): ProcessThreadInfo[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns ProcessThreadInfo[]

shift

shift(): ProcessThreadInfo | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns ProcessThreadInfo | undefined

slice

slice(start?: undefined | number, end?: undefined | number): ProcessThreadInfo[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns ProcessThreadInfo[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: ProcessThreadInfo, index: number, array: ProcessThreadInfo[]): boolean
    - Parameters
      - value: ProcessThreadInfo
      - index: number
      - array: ProcessThreadInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): ProcessThreadInfo[]
splice(start: number, deleteCount: number, ...items: ProcessThreadInfo[]): ProcessThreadInfo[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns ProcessThreadInfo[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: ProcessThreadInfo[]
  
  Elements to insert into the array in place of the deleted elements.
Returns ProcessThreadInfo[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: ProcessThreadInfo[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: ProcessThreadInfo[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<ProcessThreadInfo>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<ProcessThreadInfo>

type

type: object

className

className: string = "ProcessThreadInfoCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "ProcessThreadInfo"

name

Const ProxyOnlyResource

ProxyOnlyResource: object

interface: An interface representing ProxyOnlyResource. Azure proxy only resource. This resource is not tracked by Azure Resource Manager.
extends: BaseResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ProxyOnlyResource"

type

type: object

member: {string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ProxyOnlyResource"

name

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

kind

kind: object

serializedName

serializedName: string = "kind"

type

type: object

name

name

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

Const PublicCertificate

PublicCertificate: object

interface: An interface representing PublicCertificate. Public certificate object
extends: ProxyOnlyResource

Optional blob

blob: Uint8Array

member: {Uint8Array} [blob] Public Certificate byte array

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicCertificateLocation

publicCertificateLocation: PublicCertificateLocation

member: {PublicCertificateLocation} [publicCertificateLocation] Public Certificate Location. Possible values include: 'CurrentUserMy', 'LocalMachineMy', 'Unknown'

serializedName

serializedName: string = "PublicCertificate"

Optional thumbprint

thumbprint: undefined | string

member: {string} [thumbprint] Certificate Thumbprint NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "properties.thumbprint"

type

type: object

name

Const PublicCertificateCollection

PublicCertificateCollection: object

interface: An interface representing the PublicCertificateCollection. Collection of public certificates
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PublicCertificateCollection"

__@iterator

__@iterator(): IterableIterator<PublicCertificate>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<PublicCertificate>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<PublicCertificate>[]): PublicCertificate[]
concat(...items: (T | ConcatArray<T>)[]): PublicCertificate[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<PublicCertificate>[]
 
 Additional items to add to the end of array1.
Returns PublicCertificate[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns PublicCertificate[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, PublicCertificate]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, PublicCertificate]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: PublicCertificate, index: number, array: PublicCertificate[]): boolean
    - Parameters
      - value: PublicCertificate
      - index: number
      - array: PublicCertificate[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: PublicCertificate, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: PublicCertificate
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): PublicCertificate[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: PublicCertificate
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: PublicCertificate, index: number, array: PublicCertificate[]): boolean
    - Parameters
      - value: PublicCertificate
      - index: number
      - array: PublicCertificate[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: PublicCertificate, index: number, array: PublicCertificate[]): any
    - Parameters
      - value: PublicCertificate
      - index: number
      - array: PublicCertificate[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns PublicCertificate[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): PublicCertificate | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: PublicCertificate
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: PublicCertificate, index: number, obj: PublicCertificate[]): boolean
    - Parameters
      - this: void
      - value: PublicCertificate
      - index: number
      - obj: PublicCertificate[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: PublicCertificate, index: number, obj: PublicCertificate[]): boolean
    - Parameters
      - value: PublicCertificate
      - index: number
      - obj: PublicCertificate[]
      Returns boolean
- Optional thisArg: any
Returns PublicCertificate | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: PublicCertificate, index: number, obj: PublicCertificate[]): boolean
    - Parameters
      - value: PublicCertificate
      - index: number
      - obj: PublicCertificate[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: PublicCertificate, index: number, array: PublicCertificate[]): void
    - Parameters
      - value: PublicCertificate
      - index: number
      - array: PublicCertificate[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: PublicCertificate, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: PublicCertificate
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: PublicCertificate, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: PublicCertificate
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: PublicCertificate, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: PublicCertificate
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: PublicCertificate, index: number, array: PublicCertificate[]): U
    - Parameters
      - value: PublicCertificate
      - index: number
      - array: PublicCertificate[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): PublicCertificate | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns PublicCertificate | undefined

push

push(...items: PublicCertificate[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: PublicCertificate[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): PublicCertificate
reduce(callbackfn: function, initialValue: PublicCertificate): PublicCertificate
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: PublicCertificate, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): PublicCertificate
    - Parameters
      - previousValue: PublicCertificate
      - currentValue: PublicCertificate
      - currentIndex: number
      - array: PublicCertificate[]
      Returns PublicCertificate
Returns PublicCertificate
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: PublicCertificate, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): PublicCertificate
    - Parameters
      - previousValue: PublicCertificate
      - currentValue: PublicCertificate
      - currentIndex: number
      - array: PublicCertificate[]
      Returns PublicCertificate
- initialValue: PublicCertificate
Returns PublicCertificate
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): U
    - Parameters
      - previousValue: U
      - currentValue: PublicCertificate
      - currentIndex: number
      - array: PublicCertificate[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): PublicCertificate
reduceRight(callbackfn: function, initialValue: PublicCertificate): PublicCertificate
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: PublicCertificate, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): PublicCertificate
    - Parameters
      - previousValue: PublicCertificate
      - currentValue: PublicCertificate
      - currentIndex: number
      - array: PublicCertificate[]
      Returns PublicCertificate
Returns PublicCertificate
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: PublicCertificate, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): PublicCertificate
    - Parameters
      - previousValue: PublicCertificate
      - currentValue: PublicCertificate
      - currentIndex: number
      - array: PublicCertificate[]
      Returns PublicCertificate
- initialValue: PublicCertificate
Returns PublicCertificate
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: PublicCertificate, currentIndex: number, array: PublicCertificate[]): U
    - Parameters
      - previousValue: U
      - currentValue: PublicCertificate
      - currentIndex: number
      - array: PublicCertificate[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): PublicCertificate[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns PublicCertificate[]

shift

shift(): PublicCertificate | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns PublicCertificate | undefined

slice

slice(start?: undefined | number, end?: undefined | number): PublicCertificate[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns PublicCertificate[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: PublicCertificate, index: number, array: PublicCertificate[]): boolean
    - Parameters
      - value: PublicCertificate
      - index: number
      - array: PublicCertificate[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): PublicCertificate[]
splice(start: number, deleteCount: number, ...items: PublicCertificate[]): PublicCertificate[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns PublicCertificate[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: PublicCertificate[]
  
  Elements to insert into the array in place of the deleted elements.
Returns PublicCertificate[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: PublicCertificate[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: PublicCertificate[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<PublicCertificate>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<PublicCertificate>

type

type: object

className

className: string = "PublicCertificateCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "PublicCertificate"

name

Const PushSettings

PushSettings: object

interface: An interface representing PushSettings. Push settings for the App.
extends: ProxyOnlyResource

Optional dynamicTagsJson

dynamicTagsJson: undefined | string

member: {string} [dynamicTagsJson] Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

isPushEnabled

isPushEnabled: boolean

member: {boolean} isPushEnabled Gets or sets a flag indicating whether the Push endpoint is enabled.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "PushSettings"

Optional tagWhitelistJson

tagWhitelistJson: undefined | string

member: {string} [tagWhitelistJson] Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.

Optional tagsRequiringAuth

tagsRequiringAuth: undefined | string

member: {string} [tagsRequiringAuth] Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: '_', '@', '#', '.', ':', '-'. Validation should be performed at the PushRequestHandler.

type

type: object

className

className: string = "PushSettings"

name

modelProperties

modelProperties: object

dynamicTagsJson

dynamicTagsJson: object

serializedName

serializedName: string = "properties.dynamicTagsJson"

type

type: object

name

isPushEnabled

name

Const RampUpRule

RampUpRule: object

interface: An interface representing RampUpRule. Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.

Optional actionHostName

actionHostName: undefined | string

member: {string} [actionHostName] Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

Optional changeDecisionCallbackUrl

changeDecisionCallbackUrl: undefined | string

member: {string} [changeDecisionCallbackUrl] Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/

Optional changeIntervalInMinutes

changeIntervalInMinutes: undefined | number

member: {number} [changeIntervalInMinutes] Specifies interval in mimuntes to reevaluate ReroutePercentage.

Optional changeStep

changeStep: undefined | number

member: {number} [changeStep] In auto ramp up scenario this is the step to to add/remove from ReroutePercentage until it reaches MinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes. Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.

Optional maxReroutePercentage

maxReroutePercentage: undefined | number

member: {number} [maxReroutePercentage] Specifies upper boundary below which ReroutePercentage will stay.

Optional minReroutePercentage

minReroutePercentage: undefined | number

member: {number} [minReroutePercentage] Specifies lower boundary above which ReroutePercentage will stay.

Optional name

member: {string} [name] Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

Optional reroutePercentage

reroutePercentage: undefined | number

member: {number} [reroutePercentage] Percentage of the traffic which will be redirected to ActionHostName.

serializedName

serializedName: string = "RampUpRule"

type

type: object

className

className: string = "RampUpRule"

name

modelProperties

name

name

serializedName

serializedName: string = "name"

type

type: object

name

reroutePercentage

reroutePercentage: object

serializedName

serializedName: string = "reroutePercentage"

type

type: object

name

Const Recommendation

Recommendation: object

interface: An interface representing Recommendation. Represents a recommendation result generated by the recommendation engine.
extends: ProxyOnlyResource

Optional actionName

actionName: undefined | string

member: {string} [actionName] Name of action recommended by this object.

Optional bladeName

bladeName: undefined | string

member: {string} [bladeName] Deep link to a blade on the portal.

Optional categoryTags

categoryTags: string[]

member: {string[]} [categoryTags] The list of category tags that this recommendation belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional channels

channels: Channels

member: {Channels} [channels] List of channels that this recommendation can apply. Possible values include: 'Notification', 'Api', 'Email', 'Webhook', 'All'

Optional creationTime

creationTime: Date

member: {Date} [creationTime] Timestamp when this instance was created.

Optional displayName

displayName: undefined | string

member: {string} [displayName] UI friendly name of the rule (may not be unique).

Optional enabled

enabled: undefined | number

member: {number} [enabled] True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.

Optional endTime

endTime: Date

member: {Date} [endTime] The end time in UTC of a range that the recommendation refers to.

Optional extensionName

extensionName: undefined | string

member: {string} [extensionName] Extension name of the portal if exists.

Optional forwardLink

forwardLink: undefined | string

member: {string} [forwardLink] Forward link to an external document associated with the rule.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isDynamic

isDynamic: undefined | false | true

member: {boolean} [isDynamic] True if this is associated with a dynamically added rule

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional level

level: NotificationLevel

member: {NotificationLevel} [level] Level indicating how critical this recommendation can impact. Possible values include: 'Critical', 'Warning', 'Information', 'NonUrgentSuggestion'

Optional message

message: undefined | string

member: {string} [message] Recommendation text.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextNotificationTime

nextNotificationTime: Date

member: {Date} [nextNotificationTime] When to notify this recommendation next in UTC. Null means that this will never be notified anymore.

Optional notificationExpirationTime

notificationExpirationTime: Date

member: {Date} [notificationExpirationTime] Date and time in UTC when this notification expires.

Optional notifiedTime

notifiedTime: Date

member: {Date} [notifiedTime] Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet.

Optional recommendationId

recommendationId: undefined | string

member: {string} [recommendationId] A GUID value that each recommendation object is associated with.

Optional resourceId

resourceId: undefined | string

member: {string} [resourceId] Full ARM resource ID string that this recommendation object is associated with.

Optional resourceScope

resourceScope: ResourceScopeType

member: {ResourceScopeType} [resourceScope] Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site. Possible values include: 'ServerFarm', 'Subscription', 'WebSite'

Optional ruleName

ruleName: undefined | string

member: {string} [ruleName] Unique name of the rule.

Optional score

score: undefined | number

member: {number} [score] A metric value measured by the rule.

serializedName

serializedName: string = "Recommendation"

Optional startTime

startTime: Date

member: {Date} [startTime] The beginning time in UTC of a range that the recommendation refers to.

Optional states

states: string[]

member: {string[]} [states] The list of states of this recommendation. If it's null then it shoud be considered "Active".

type

type: object

className

className: string = "Recommendation"

name

modelProperties

modelProperties: object

actionName

name

Const RecommendationCollection

RecommendationCollection: object

interface: An interface representing the RecommendationCollection. Collection of recommendations.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RecommendationCollection"

__@iterator

__@iterator(): IterableIterator<Recommendation>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<Recommendation>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<Recommendation>[]): Recommendation[]
concat(...items: (T | ConcatArray<T>)[]): Recommendation[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<Recommendation>[]
 
 Additional items to add to the end of array1.
Returns Recommendation[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns Recommendation[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, Recommendation]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, Recommendation]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: Recommendation, index: number, array: Recommendation[]): boolean
    - Parameters
      - value: Recommendation
      - index: number
      - array: Recommendation[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: Recommendation, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: Recommendation
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): Recommendation[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: Recommendation
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Recommendation, index: number, array: Recommendation[]): boolean
    - Parameters
      - value: Recommendation
      - index: number
      - array: Recommendation[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Recommendation, index: number, array: Recommendation[]): any
    - Parameters
      - value: Recommendation
      - index: number
      - array: Recommendation[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Recommendation[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): Recommendation | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: Recommendation
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: Recommendation, index: number, obj: Recommendation[]): boolean
    - Parameters
      - this: void
      - value: Recommendation
      - index: number
      - obj: Recommendation[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: Recommendation, index: number, obj: Recommendation[]): boolean
    - Parameters
      - value: Recommendation
      - index: number
      - obj: Recommendation[]
      Returns boolean
- Optional thisArg: any
Returns Recommendation | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: Recommendation, index: number, obj: Recommendation[]): boolean
    - Parameters
      - value: Recommendation
      - index: number
      - obj: Recommendation[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: Recommendation, index: number, array: Recommendation[]): void
    - Parameters
      - value: Recommendation
      - index: number
      - array: Recommendation[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: Recommendation, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: Recommendation
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: Recommendation, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: Recommendation
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: Recommendation, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: Recommendation
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: Recommendation, index: number, array: Recommendation[]): U
    - Parameters
      - value: Recommendation
      - index: number
      - array: Recommendation[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): Recommendation | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns Recommendation | undefined

push

push(...items: Recommendation[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: Recommendation[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): Recommendation
reduce(callbackfn: function, initialValue: Recommendation): Recommendation
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Recommendation, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): Recommendation
    - Parameters
      - previousValue: Recommendation
      - currentValue: Recommendation
      - currentIndex: number
      - array: Recommendation[]
      Returns Recommendation
Returns Recommendation
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: Recommendation, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): Recommendation
    - Parameters
      - previousValue: Recommendation
      - currentValue: Recommendation
      - currentIndex: number
      - array: Recommendation[]
      Returns Recommendation
- initialValue: Recommendation
Returns Recommendation
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): U
    - Parameters
      - previousValue: U
      - currentValue: Recommendation
      - currentIndex: number
      - array: Recommendation[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): Recommendation
reduceRight(callbackfn: function, initialValue: Recommendation): Recommendation
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Recommendation, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): Recommendation
    - Parameters
      - previousValue: Recommendation
      - currentValue: Recommendation
      - currentIndex: number
      - array: Recommendation[]
      Returns Recommendation
Returns Recommendation
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: Recommendation, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): Recommendation
    - Parameters
      - previousValue: Recommendation
      - currentValue: Recommendation
      - currentIndex: number
      - array: Recommendation[]
      Returns Recommendation
- initialValue: Recommendation
Returns Recommendation
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Recommendation, currentIndex: number, array: Recommendation[]): U
    - Parameters
      - previousValue: U
      - currentValue: Recommendation
      - currentIndex: number
      - array: Recommendation[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): Recommendation[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns Recommendation[]

shift

shift(): Recommendation | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns Recommendation | undefined

slice

slice(start?: undefined | number, end?: undefined | number): Recommendation[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns Recommendation[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: Recommendation, index: number, array: Recommendation[]): boolean
    - Parameters
      - value: Recommendation
      - index: number
      - array: Recommendation[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): Recommendation[]
splice(start: number, deleteCount: number, ...items: Recommendation[]): Recommendation[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns Recommendation[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: Recommendation[]
  
  Elements to insert into the array in place of the deleted elements.
Returns Recommendation[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: Recommendation[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: Recommendation[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<Recommendation>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<Recommendation>

type

type: object

className

className: string = "RecommendationCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "Recommendation"

name

Const RecommendationRule

RecommendationRule: object

interface: An interface representing RecommendationRule. Represents a recommendation rule that the recommendation engine can perform.
extends: ProxyOnlyResource

Optional actionName

actionName: undefined | string

member: {string} [actionName] Name of action that is recommended by this rule in string.

Optional bladeName

bladeName: undefined | string

member: {string} [bladeName] Deep link to a blade on the portal. Applicable to dynamic rule only.

Optional categoryTags

categoryTags: string[]

member: {string[]} [categoryTags] The list of category tags that this recommendation rule belongs to. NOTE: This property will not be serialized. It can only be populated by the server.

Optional channels

channels: Channels

member: {Channels} [channels] List of available channels that this rule applies. Possible values include: 'Notification', 'Api', 'Email', 'Webhook', 'All'

Optional description

description: undefined | string

member: {string} [description] Localized detailed description of the rule.

Optional displayName

displayName: undefined | string

member: {string} [displayName] UI friendly name of the rule.

Optional extensionName

extensionName: undefined | string

member: {string} [extensionName] Extension name of the portal if exists. Applicable to dynamic rule only.

Optional forwardLink

forwardLink: undefined | string

member: {string} [forwardLink] Forward link to an external document associated with the rule. Applicable to dynamic rule only.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isDynamic

isDynamic: undefined | false | true

member: {boolean} [isDynamic] True if this is associated with a dynamically added rule

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional level

level: NotificationLevel

member: {NotificationLevel} [level] Level of impact indicating how critical this rule is. Possible values include: 'Critical', 'Warning', 'Information', 'NonUrgentSuggestion'

Optional message

message: undefined | string

member: {string} [message] Localized name of the rule (Good for UI).

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional recommendationId

recommendationId: undefined | string

member: {string} [recommendationId] Recommendation ID of an associated recommendation object tied to the rule, if exists. If such an object doesn't exist, it is set to null.

Optional recommendationName

recommendationName: undefined | string

member: {string} [recommendationName] Unique name of the rule.

serializedName

serializedName: string = "RecommendationRule"

type

type: object

className

className: string = "RecommendationRule"

name

modelProperties

modelProperties: object

actionName

type

type: object

name

Const ReissueCertificateOrderRequest

ReissueCertificateOrderRequest: object

interface: An interface representing ReissueCertificateOrderRequest. Class representing certificate reissue request.
extends: ProxyOnlyResource

Optional csr

csr: undefined | string

member: {string} [csr] Csr to be used for re-key operation.

Optional delayExistingRevokeInHours

delayExistingRevokeInHours: undefined | number

member: {number} [delayExistingRevokeInHours] Delay in hours to revoke existing certificate after the new certificate is issued.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isPrivateKeyExternal

isPrivateKeyExternal: undefined | false | true

member: {boolean} [isPrivateKeyExternal] Should we change the ASC type (from managed private key to external private key and vice versa).

Optional keySize

keySize: undefined | number

member: {number} [keySize] Certificate Key Size.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ReissueCertificateOrderRequest"

type

type: object

className

className: string = "ReissueCertificateOrderRequest"

name

modelProperties

name

Const RelayServiceConnectionEntity

RelayServiceConnectionEntity: object

interface: An interface representing RelayServiceConnectionEntity. Hybrid Connection for an App Service app.
extends: ProxyOnlyResource

Optional biztalkUri

biztalkUri: undefined | string

member: {string} [biztalkUri]

Optional entityConnectionString

entityConnectionString: undefined | string

member: {string} [entityConnectionString]

Optional entityName

entityName: undefined | string

member: {string} [entityName]

Optional hostname

hostname: undefined | string

member: {string} [hostname]

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional port

port: undefined | number

member: {number} [port]

Optional resourceConnectionString

resourceConnectionString: undefined | string

member: {string} [resourceConnectionString]

Optional resourceType

resourceType: undefined | string

member: {string} [resourceType]

serializedName

serializedName: string = "RelayServiceConnectionEntity"

type

type: object

className

className: string = "RelayServiceConnectionEntity"

name

modelProperties

name

Const Rendering

Rendering: object

interface: An interface representing Rendering. Instructions for rendering the data

Optional description

description: undefined | string

member: {string} [description] Description of the data that will help it be interpreted

serializedName

serializedName: string = "Rendering"

Optional title

title: undefined | string

member: {string} [title] Title of data

type

type: object

member: {RenderingType} [type] Rendering Type. Possible values include: 'NoGraph', 'Table', 'TimeSeries', 'TimeSeriesPerInstance'

className

className: string = "Rendering"

name

modelProperties

allowedValues

allowedValues: string[] = ["NoGraph","Table","TimeSeries","TimeSeriesPerInstance"]

name

Const RenewCertificateOrderRequest

RenewCertificateOrderRequest: object

interface: An interface representing RenewCertificateOrderRequest. Class representing certificate renew request.
extends: ProxyOnlyResource

Optional csr

csr: undefined | string

member: {string} [csr] Csr to be used for re-key operation.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isPrivateKeyExternal

isPrivateKeyExternal: undefined | false | true

member: {boolean} [isPrivateKeyExternal] Should we change the ASC type (from managed private key to external private key and vice versa).

Optional keySize

keySize: undefined | number

member: {number} [keySize] Certificate Key Size.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "RenewCertificateOrderRequest"

type

type: object

className

className: string = "RenewCertificateOrderRequest"

name

modelProperties

name

Const RequestsBasedTrigger

RequestsBasedTrigger: object

interface: An interface representing RequestsBasedTrigger. Trigger based on total requests.

Optional count

member: {number} [count] Request Count.

serializedName

serializedName: string = "RequestsBasedTrigger"

Optional timeInterval

timeInterval: undefined | string

member: {string} [timeInterval] Time interval.

type

type: object

className

className: string = "RequestsBasedTrigger"

name

modelProperties

modelProperties: object

count

serializedName

serializedName: string = "count"

type

type: object

name

timeInterval

timeInterval: object

serializedName

serializedName: string = "timeInterval"

type

type: object

name

Const Resource

Resource: object

interface: An interface representing Resource. Azure resource. This resource is tracked in Azure Resource Manager
extends: BaseResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

location

location: string

member: {string} location Resource Location.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Resource"

Optional tags

tags: undefined | object

member: {{ [propertyName: string]: string }} [tags] Resource tags.

type

type: object

member: {string} [type] Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

modelProperties

modelProperties: object

id

type

type: object

name

name

readOnly

serializedName

serializedName: string = "type"

type

type: object

name

Const ResourceCollection

ResourceCollection: object

interface: An interface representing the ResourceCollection. Collection of resources.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceCollection"

__@iterator

__@iterator(): IterableIterator<string>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<string>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<string>[]): string[]
concat(...items: (T | ConcatArray<T>)[]): string[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<string>[]
 
 Additional items to add to the end of array1.
Returns string[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns string[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, string]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, string]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: string, index: number, array: string[]): boolean
    - Parameters
      - value: string
      - index: number
      - array: string[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: string, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: string
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): string[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: string
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: string, index: number, array: string[]): boolean
    - Parameters
      - value: string
      - index: number
      - array: string[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: string, index: number, array: string[]): any
    - Parameters
      - value: string
      - index: number
      - array: string[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns string[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): string | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: string
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: string, index: number, obj: string[]): boolean
    - Parameters
      - this: void
      - value: string
      - index: number
      - obj: string[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: string, index: number, obj: string[]): boolean
    - Parameters
      - value: string
      - index: number
      - obj: string[]
      Returns boolean
- Optional thisArg: any
Returns string | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: string, index: number, obj: string[]): boolean
    - Parameters
      - value: string
      - index: number
      - obj: string[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: string, index: number, array: string[]): void
    - Parameters
      - value: string
      - index: number
      - array: string[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: string, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: string
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: string, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: string
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: string, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: string
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: string, index: number, array: string[]): U
    - Parameters
      - value: string
      - index: number
      - array: string[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): string | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns string | undefined

push

push(...items: string[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: string[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): string
reduce(callbackfn: function, initialValue: string): string
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: string, currentValue: string, currentIndex: number, array: string[]): string
    - Parameters
      - previousValue: string
      - currentValue: string
      - currentIndex: number
      - array: string[]
      Returns string
Returns string
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: string, currentValue: string, currentIndex: number, array: string[]): string
    - Parameters
      - previousValue: string
      - currentValue: string
      - currentIndex: number
      - array: string[]
      Returns string
- initialValue: string
Returns string
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: string, currentIndex: number, array: string[]): U
    - Parameters
      - previousValue: U
      - currentValue: string
      - currentIndex: number
      - array: string[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): string
reduceRight(callbackfn: function, initialValue: string): string
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: string, currentValue: string, currentIndex: number, array: string[]): string
    - Parameters
      - previousValue: string
      - currentValue: string
      - currentIndex: number
      - array: string[]
      Returns string
Returns string
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: string, currentValue: string, currentIndex: number, array: string[]): string
    - Parameters
      - previousValue: string
      - currentValue: string
      - currentIndex: number
      - array: string[]
      Returns string
- initialValue: string
Returns string
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: string, currentIndex: number, array: string[]): U
    - Parameters
      - previousValue: U
      - currentValue: string
      - currentIndex: number
      - array: string[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): string[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns string[]

shift

shift(): string | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns string | undefined

slice

slice(start?: undefined | number, end?: undefined | number): string[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns string[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: string, index: number, array: string[]): boolean
    - Parameters
      - value: string
      - index: number
      - array: string[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): string[]
splice(start: number, deleteCount: number, ...items: string[]): string[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns string[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: string[]
  
  Elements to insert into the array in place of the deleted elements.
Returns string[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: string[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: string[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<string>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<string>

type

type: object

className

className: string = "ResourceCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

ResourceHealthMetadata: object

interface: An interface representing ResourceHealthMetadata. Used for getting ResourceHealthCheck settings.
extends: ProxyOnlyResource

Optional category

category: undefined | string

member: {string} [category] The category that the resource matches in the RHC Policy File

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceHealthMetadata"

Optional signalAvailability

signalAvailability: undefined | false | true

member: {boolean} [signalAvailability] Is there a health signal for the resource

interface: An interface representing the ResourceHealthMetadataCollection. Collection of resource health metadata.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceHealthMetadataCollection"

__@iterator

__@iterator(): IterableIterator<ResourceHealthMetadata>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<ResourceHealthMetadata>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<ResourceHealthMetadata>[]): ResourceHealthMetadata[]
concat(...items: (T | ConcatArray<T>)[]): ResourceHealthMetadata[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<ResourceHealthMetadata>[]
 
 Additional items to add to the end of array1.
Returns ResourceHealthMetadata[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns ResourceHealthMetadata[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, ResourceHealthMetadata]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, ResourceHealthMetadata]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: ResourceHealthMetadata, index: number, array: ResourceHealthMetadata[]): boolean
    - Parameters
      - value: ResourceHealthMetadata
      - index: number
      - array: ResourceHealthMetadata[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: ResourceHealthMetadata, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: ResourceHealthMetadata
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): ResourceHealthMetadata[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: ResourceHealthMetadata
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ResourceHealthMetadata, index: number, array: ResourceHealthMetadata[]): boolean
    - Parameters
      - value: ResourceHealthMetadata
      - index: number
      - array: ResourceHealthMetadata[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ResourceHealthMetadata, index: number, array: ResourceHealthMetadata[]): any
    - Parameters
      - value: ResourceHealthMetadata
      - index: number
      - array: ResourceHealthMetadata[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns ResourceHealthMetadata[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): ResourceHealthMetadata | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: ResourceHealthMetadata
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: ResourceHealthMetadata, index: number, obj: ResourceHealthMetadata[]): boolean
    - Parameters
      - this: void
      - value: ResourceHealthMetadata
      - index: number
      - obj: ResourceHealthMetadata[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: ResourceHealthMetadata, index: number, obj: ResourceHealthMetadata[]): boolean
    - Parameters
      - value: ResourceHealthMetadata
      - index: number
      - obj: ResourceHealthMetadata[]
      Returns boolean
- Optional thisArg: any
Returns ResourceHealthMetadata | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: ResourceHealthMetadata, index: number, obj: ResourceHealthMetadata[]): boolean
    - Parameters
      - value: ResourceHealthMetadata
      - index: number
      - obj: ResourceHealthMetadata[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: ResourceHealthMetadata, index: number, array: ResourceHealthMetadata[]): void
    - Parameters
      - value: ResourceHealthMetadata
      - index: number
      - array: ResourceHealthMetadata[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: ResourceHealthMetadata, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: ResourceHealthMetadata
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: ResourceHealthMetadata, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: ResourceHealthMetadata
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: ResourceHealthMetadata, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: ResourceHealthMetadata
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: ResourceHealthMetadata, index: number, array: ResourceHealthMetadata[]): U
    - Parameters
      - value: ResourceHealthMetadata
      - index: number
      - array: ResourceHealthMetadata[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): ResourceHealthMetadata | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns ResourceHealthMetadata | undefined

push

push(...items: ResourceHealthMetadata[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: ResourceHealthMetadata[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): ResourceHealthMetadata
reduce(callbackfn: function, initialValue: ResourceHealthMetadata): ResourceHealthMetadata
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ResourceHealthMetadata, currentValue: ResourceHealthMetadata, currentIndex: number, array: ResourceHealthMetadata[]): ResourceHealthMetadata
    - Parameters
      - previousValue: ResourceHealthMetadata
      - currentValue: ResourceHealthMetadata
      - currentIndex: number
      - array: ResourceHealthMetadata[]
      Returns ResourceHealthMetadata
Returns ResourceHealthMetadata
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: ResourceHealthMetadata, currentValue: ResourceHealthMetadata, currentIndex: number, array: ResourceHealthMetadata[]): ResourceHealthMetadata
    - Parameters
      - previousValue: ResourceHealthMetadata
      - currentValue: ResourceHealthMetadata
      - currentIndex: number
      - array: ResourceHealthMetadata[]
      Returns ResourceHealthMetadata
- initialValue: ResourceHealthMetadata
Returns ResourceHealthMetadata
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ResourceHealthMetadata, currentIndex: number, array: ResourceHealthMetadata[]): U
    - Parameters
      - previousValue: U
      - currentValue: ResourceHealthMetadata
      - currentIndex: number
      - array: ResourceHealthMetadata[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): ResourceHealthMetadata
reduceRight(callbackfn: function, initialValue: ResourceHealthMetadata): ResourceHealthMetadata
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ResourceHealthMetadata, currentValue: ResourceHealthMetadata, currentIndex: number, array: ResourceHealthMetadata[]): ResourceHealthMetadata
    - Parameters
      - previousValue: ResourceHealthMetadata
      - currentValue: ResourceHealthMetadata
      - currentIndex: number
      - array: ResourceHealthMetadata[]
      Returns ResourceHealthMetadata
Returns ResourceHealthMetadata
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: ResourceHealthMetadata, currentValue: ResourceHealthMetadata, currentIndex: number, array: ResourceHealthMetadata[]): ResourceHealthMetadata
    - Parameters
      - previousValue: ResourceHealthMetadata
      - currentValue: ResourceHealthMetadata
      - currentIndex: number
      - array: ResourceHealthMetadata[]
      Returns ResourceHealthMetadata
- initialValue: ResourceHealthMetadata
Returns ResourceHealthMetadata
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ResourceHealthMetadata, currentIndex: number, array: ResourceHealthMetadata[]): U
    - Parameters
      - previousValue: U
      - currentValue: ResourceHealthMetadata
      - currentIndex: number
      - array: ResourceHealthMetadata[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): ResourceHealthMetadata[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns ResourceHealthMetadata[]

shift

shift(): ResourceHealthMetadata | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns ResourceHealthMetadata | undefined

slice

slice(start?: undefined | number, end?: undefined | number): ResourceHealthMetadata[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns ResourceHealthMetadata[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: ResourceHealthMetadata, index: number, array: ResourceHealthMetadata[]): boolean
    - Parameters
      - value: ResourceHealthMetadata
      - index: number
      - array: ResourceHealthMetadata[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): ResourceHealthMetadata[]
splice(start: number, deleteCount: number, ...items: ResourceHealthMetadata[]): ResourceHealthMetadata[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns ResourceHealthMetadata[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: ResourceHealthMetadata[]
  
  Elements to insert into the array in place of the deleted elements.
Returns ResourceHealthMetadata[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: ResourceHealthMetadata[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: ResourceHealthMetadata[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<ResourceHealthMetadata>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<ResourceHealthMetadata>

type

type: object

className

className: string = "ResourceHealthMetadataCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "ResourceHealthMetadata"

name

Const ResourceMetric

ResourceMetric: object

interface: An interface representing ResourceMetric. Object representing a metric for any resource .

Optional endTime

endTime: Date

member: {Date} [endTime] Metric end time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional metricValues

metricValues: ResourceMetricValue[]

member: {ResourceMetricValue[]} [metricValues] Metric values. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {ResourceMetricName} [name] Name of metric. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: ResourceMetricProperty[]

member: {ResourceMetricProperty[]} [properties] Resource metric properties collection. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceId

resourceId: undefined | string

member: {string} [resourceId] Metric resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetric"

Optional startTime

startTime: Date

member: {Date} [startTime] Metric start time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional timeGrain

timeGrain: undefined | string

member: {string} [timeGrain] Metric granularity. E.g PT1H, PT5M, P1D NOTE: This property will not be serialized. It can only be populated by the server.

Optional unit

unit: undefined | string

member: {string} [unit] Metric unit. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ResourceMetric"

name

modelProperties

name

element

element: object

type

type: object

className

className: string = "ResourceMetricValue"

Const ResourceMetricAvailability

ResourceMetricAvailability: object

interface: An interface representing ResourceMetricAvailability. Metrics availability and retention.

Optional retention

retention: undefined | string

member: {string} [retention] Retention period for the current time grain. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricAvailability"

Optional timeGrain

timeGrain: undefined | string

member: {string} [timeGrain] Time grain . NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ResourceMetricAvailability"

name

modelProperties

modelProperties: object

retention

retention: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "retention"

type

type: object

name

timeGrain

timeGrain: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "timeGrain"

type

type: object

name

Const ResourceMetricCollection

ResourceMetricCollection: object

interface: An interface representing the ResourceMetricCollection. Collection of metric responses.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricCollection"

__@iterator

__@iterator(): IterableIterator<ResourceMetric>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<ResourceMetric>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<ResourceMetric>[]): ResourceMetric[]
concat(...items: (T | ConcatArray<T>)[]): ResourceMetric[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<ResourceMetric>[]
 
 Additional items to add to the end of array1.
Returns ResourceMetric[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns ResourceMetric[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, ResourceMetric]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, ResourceMetric]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: ResourceMetric, index: number, array: ResourceMetric[]): boolean
    - Parameters
      - value: ResourceMetric
      - index: number
      - array: ResourceMetric[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: ResourceMetric, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: ResourceMetric
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): ResourceMetric[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: ResourceMetric
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ResourceMetric, index: number, array: ResourceMetric[]): boolean
    - Parameters
      - value: ResourceMetric
      - index: number
      - array: ResourceMetric[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ResourceMetric, index: number, array: ResourceMetric[]): any
    - Parameters
      - value: ResourceMetric
      - index: number
      - array: ResourceMetric[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns ResourceMetric[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): ResourceMetric | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: ResourceMetric
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: ResourceMetric, index: number, obj: ResourceMetric[]): boolean
    - Parameters
      - this: void
      - value: ResourceMetric
      - index: number
      - obj: ResourceMetric[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: ResourceMetric, index: number, obj: ResourceMetric[]): boolean
    - Parameters
      - value: ResourceMetric
      - index: number
      - obj: ResourceMetric[]
      Returns boolean
- Optional thisArg: any
Returns ResourceMetric | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: ResourceMetric, index: number, obj: ResourceMetric[]): boolean
    - Parameters
      - value: ResourceMetric
      - index: number
      - obj: ResourceMetric[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: ResourceMetric, index: number, array: ResourceMetric[]): void
    - Parameters
      - value: ResourceMetric
      - index: number
      - array: ResourceMetric[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: ResourceMetric, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: ResourceMetric
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: ResourceMetric, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: ResourceMetric
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: ResourceMetric, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: ResourceMetric
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: ResourceMetric, index: number, array: ResourceMetric[]): U
    - Parameters
      - value: ResourceMetric
      - index: number
      - array: ResourceMetric[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): ResourceMetric | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns ResourceMetric | undefined

push

push(...items: ResourceMetric[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: ResourceMetric[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): ResourceMetric
reduce(callbackfn: function, initialValue: ResourceMetric): ResourceMetric
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ResourceMetric, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): ResourceMetric
    - Parameters
      - previousValue: ResourceMetric
      - currentValue: ResourceMetric
      - currentIndex: number
      - array: ResourceMetric[]
      Returns ResourceMetric
Returns ResourceMetric
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: ResourceMetric, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): ResourceMetric
    - Parameters
      - previousValue: ResourceMetric
      - currentValue: ResourceMetric
      - currentIndex: number
      - array: ResourceMetric[]
      Returns ResourceMetric
- initialValue: ResourceMetric
Returns ResourceMetric
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): U
    - Parameters
      - previousValue: U
      - currentValue: ResourceMetric
      - currentIndex: number
      - array: ResourceMetric[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): ResourceMetric
reduceRight(callbackfn: function, initialValue: ResourceMetric): ResourceMetric
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ResourceMetric, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): ResourceMetric
    - Parameters
      - previousValue: ResourceMetric
      - currentValue: ResourceMetric
      - currentIndex: number
      - array: ResourceMetric[]
      Returns ResourceMetric
Returns ResourceMetric
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: ResourceMetric, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): ResourceMetric
    - Parameters
      - previousValue: ResourceMetric
      - currentValue: ResourceMetric
      - currentIndex: number
      - array: ResourceMetric[]
      Returns ResourceMetric
- initialValue: ResourceMetric
Returns ResourceMetric
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ResourceMetric, currentIndex: number, array: ResourceMetric[]): U
    - Parameters
      - previousValue: U
      - currentValue: ResourceMetric
      - currentIndex: number
      - array: ResourceMetric[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): ResourceMetric[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns ResourceMetric[]

shift

shift(): ResourceMetric | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns ResourceMetric | undefined

slice

slice(start?: undefined | number, end?: undefined | number): ResourceMetric[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns ResourceMetric[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: ResourceMetric, index: number, array: ResourceMetric[]): boolean
    - Parameters
      - value: ResourceMetric
      - index: number
      - array: ResourceMetric[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): ResourceMetric[]
splice(start: number, deleteCount: number, ...items: ResourceMetric[]): ResourceMetric[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns ResourceMetric[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: ResourceMetric[]
  
  Elements to insert into the array in place of the deleted elements.
Returns ResourceMetric[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: ResourceMetric[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: ResourceMetric[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<ResourceMetric>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<ResourceMetric>

type

type: object

className

className: string = "ResourceMetricCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "ResourceMetric"

name

Const ResourceMetricDefinition

ResourceMetricDefinition: object

interface: An interface representing ResourceMetricDefinition. Metadata for the metrics.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional metricAvailabilities

metricAvailabilities: ResourceMetricAvailability[]

member: {ResourceMetricAvailability[]} [metricAvailabilities] List of time grains supported for the metric together with retention period. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional primaryAggregationType

primaryAggregationType: undefined | string

member: {string} [primaryAggregationType] Primary aggregation type. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | object

member: {{ [propertyName: string]: string }} [properties] Resource metric definition properties. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceUri

resourceUri: undefined | string

member: {string} [resourceUri] Resource URI. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricDefinition"

Optional unit

unit: undefined | string

member: {string} [unit] Unit of the metric. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ResourceMetricDefinition"

name

modelProperties

modelProperties: object

metricAvailabilities

metricAvailabilities: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.metricAvailabilities"

type

type: object

value: object

type

type: object

name

resourceUri

resourceUri: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.resourceUri"

type

type: object

name

unit

unit: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.unit"

type

type: object

name

Const ResourceMetricDefinitionCollection

ResourceMetricDefinitionCollection: object

interface: An interface representing the ResourceMetricDefinitionCollection. Collection of metric definitions.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricDefinitionCollection"

__@iterator

__@iterator(): IterableIterator<ResourceMetricDefinition>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<ResourceMetricDefinition>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<ResourceMetricDefinition>[]): ResourceMetricDefinition[]
concat(...items: (T | ConcatArray<T>)[]): ResourceMetricDefinition[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<ResourceMetricDefinition>[]
 
 Additional items to add to the end of array1.
Returns ResourceMetricDefinition[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns ResourceMetricDefinition[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, ResourceMetricDefinition]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, ResourceMetricDefinition]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): boolean
    - Parameters
      - value: ResourceMetricDefinition
      - index: number
      - array: ResourceMetricDefinition[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: ResourceMetricDefinition, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: ResourceMetricDefinition
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): ResourceMetricDefinition[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: ResourceMetricDefinition
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): boolean
    - Parameters
      - value: ResourceMetricDefinition
      - index: number
      - array: ResourceMetricDefinition[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): any
    - Parameters
      - value: ResourceMetricDefinition
      - index: number
      - array: ResourceMetricDefinition[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns ResourceMetricDefinition[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): ResourceMetricDefinition | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: ResourceMetricDefinition
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: ResourceMetricDefinition, index: number, obj: ResourceMetricDefinition[]): boolean
    - Parameters
      - this: void
      - value: ResourceMetricDefinition
      - index: number
      - obj: ResourceMetricDefinition[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: ResourceMetricDefinition, index: number, obj: ResourceMetricDefinition[]): boolean
    - Parameters
      - value: ResourceMetricDefinition
      - index: number
      - obj: ResourceMetricDefinition[]
      Returns boolean
- Optional thisArg: any
Returns ResourceMetricDefinition | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: ResourceMetricDefinition, index: number, obj: ResourceMetricDefinition[]): boolean
    - Parameters
      - value: ResourceMetricDefinition
      - index: number
      - obj: ResourceMetricDefinition[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): void
    - Parameters
      - value: ResourceMetricDefinition
      - index: number
      - array: ResourceMetricDefinition[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: ResourceMetricDefinition, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: ResourceMetricDefinition
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: ResourceMetricDefinition, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: ResourceMetricDefinition
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: ResourceMetricDefinition, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: ResourceMetricDefinition
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): U
    - Parameters
      - value: ResourceMetricDefinition
      - index: number
      - array: ResourceMetricDefinition[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): ResourceMetricDefinition | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns ResourceMetricDefinition | undefined

push

push(...items: ResourceMetricDefinition[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: ResourceMetricDefinition[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): ResourceMetricDefinition
reduce(callbackfn: function, initialValue: ResourceMetricDefinition): ResourceMetricDefinition
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ResourceMetricDefinition, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): ResourceMetricDefinition
    - Parameters
      - previousValue: ResourceMetricDefinition
      - currentValue: ResourceMetricDefinition
      - currentIndex: number
      - array: ResourceMetricDefinition[]
      Returns ResourceMetricDefinition
Returns ResourceMetricDefinition
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: ResourceMetricDefinition, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): ResourceMetricDefinition
    - Parameters
      - previousValue: ResourceMetricDefinition
      - currentValue: ResourceMetricDefinition
      - currentIndex: number
      - array: ResourceMetricDefinition[]
      Returns ResourceMetricDefinition
- initialValue: ResourceMetricDefinition
Returns ResourceMetricDefinition
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): U
    - Parameters
      - previousValue: U
      - currentValue: ResourceMetricDefinition
      - currentIndex: number
      - array: ResourceMetricDefinition[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): ResourceMetricDefinition
reduceRight(callbackfn: function, initialValue: ResourceMetricDefinition): ResourceMetricDefinition
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: ResourceMetricDefinition, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): ResourceMetricDefinition
    - Parameters
      - previousValue: ResourceMetricDefinition
      - currentValue: ResourceMetricDefinition
      - currentIndex: number
      - array: ResourceMetricDefinition[]
      Returns ResourceMetricDefinition
Returns ResourceMetricDefinition
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: ResourceMetricDefinition, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): ResourceMetricDefinition
    - Parameters
      - previousValue: ResourceMetricDefinition
      - currentValue: ResourceMetricDefinition
      - currentIndex: number
      - array: ResourceMetricDefinition[]
      Returns ResourceMetricDefinition
- initialValue: ResourceMetricDefinition
Returns ResourceMetricDefinition
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: ResourceMetricDefinition, currentIndex: number, array: ResourceMetricDefinition[]): U
    - Parameters
      - previousValue: U
      - currentValue: ResourceMetricDefinition
      - currentIndex: number
      - array: ResourceMetricDefinition[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): ResourceMetricDefinition[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns ResourceMetricDefinition[]

shift

shift(): ResourceMetricDefinition | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns ResourceMetricDefinition | undefined

slice

slice(start?: undefined | number, end?: undefined | number): ResourceMetricDefinition[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns ResourceMetricDefinition[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: ResourceMetricDefinition, index: number, array: ResourceMetricDefinition[]): boolean
    - Parameters
      - value: ResourceMetricDefinition
      - index: number
      - array: ResourceMetricDefinition[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): ResourceMetricDefinition[]
splice(start: number, deleteCount: number, ...items: ResourceMetricDefinition[]): ResourceMetricDefinition[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns ResourceMetricDefinition[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: ResourceMetricDefinition[]
  
  Elements to insert into the array in place of the deleted elements.
Returns ResourceMetricDefinition[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: ResourceMetricDefinition[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: ResourceMetricDefinition[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<ResourceMetricDefinition>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<ResourceMetricDefinition>

type

type: object

className

className: string = "ResourceMetricDefinitionCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "ResourceMetricDefinition"

name

Const ResourceMetricName

ResourceMetricName: object

interface: An interface representing ResourceMetricName. Name of a metric for any resource .

Optional localizedValue

localizedValue: undefined | string

member: {string} [localizedValue] Localized metric name value. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricName"

Optional value

value: undefined | string

member: {string} [value] metric name value. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ResourceMetricName"

name

modelProperties

modelProperties: object

localizedValue

localizedValue: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "localizedValue"

type

type: object

name

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "value"

type

type: object

name

Const ResourceMetricProperty

ResourceMetricProperty: object

interface: An interface representing ResourceMetricProperty. Resource metric property.

Optional key

key: undefined | string

member: {string} [key] Key for resource metric property.

serializedName

serializedName: string = "ResourceMetricProperty"

Optional value

value: undefined | string

member: {string} [value] Value of pair.

type

type: object

className

className: string = "ResourceMetricProperty"

name

modelProperties

modelProperties: object

key

key: object

serializedName

serializedName: string = "key"

type

type: object

name

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

Const ResourceMetricValue

ResourceMetricValue: object

interface: An interface representing ResourceMetricValue. Value of resource metric.

Optional average

average: undefined | number

member: {number} [average] Value average. NOTE: This property will not be serialized. It can only be populated by the server.

Optional count

member: {number} [count] Value count. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maximum

maximum: undefined | number

member: {number} [maximum] Value maximum. NOTE: This property will not be serialized. It can only be populated by the server.

Optional minimum

minimum: undefined | number

member: {number} [minimum] Value minimum. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: ResourceMetricProperty[]

member: {ResourceMetricProperty[]} [properties] Resource metric properties collection. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceMetricValue"

Optional timestamp

timestamp: undefined | string

member: {string} [timestamp] Value timestamp. NOTE: This property will not be serialized. It can only be populated by the server.

Optional total

total: undefined | number

member: {number} [total] Value total. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "ResourceMetricValue"

name

modelProperties

modelProperties: object

average

average: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "average"

type

type: object

interface: An interface representing ResourceNameAvailability. Information regarding availbility of a resource name.

Optional message

message: undefined | string

member: {string} [message] If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.

Optional nameAvailable

nameAvailable: undefined | false | true

member: {boolean} [nameAvailable] true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.

Optional reason

reason: InAvailabilityReasonType

member: {InAvailabilityReasonType} [reason] Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable. Possible values include: 'Invalid', 'AlreadyExists'

serializedName

serializedName: string = "ResourceNameAvailability"

type

type: object

className

className: string = "ResourceNameAvailability"

name

modelProperties

name

Const ResourceNameAvailabilityRequest

ResourceNameAvailabilityRequest: object

interface: An interface representing ResourceNameAvailabilityRequest. Resource name availability request content.

Optional isFqdn

isFqdn: undefined | false | true

member: {boolean} [isFqdn] Is fully qualified domain name.

name

member: {string} name Resource name to verify.

serializedName

serializedName: string = "ResourceNameAvailabilityRequest"

type

type: object

member: {CheckNameResourceTypes} type Resource type used for verification. Possible values include: 'Site', 'Slot', 'HostingEnvironment', 'PublishingUser', 'Microsoft.Web/sites', 'Microsoft.Web/sites/slots', 'Microsoft.Web/hostingEnvironments', 'Microsoft.Web/publishingUsers'

className

className: string = "ResourceNameAvailabilityRequest"

name

type: object

required

required: true = true

serializedName

serializedName: string = "type"

type

type: object

name

Const ResponseMetaData

ResponseMetaData: object

interface: An interface representing ResponseMetaData.

Optional dataSource

dataSource: DataSource

member: {DataSource} [dataSource] Source of the Data

serializedName

serializedName: string = "ResponseMetaData"

type

type: object

className

className: string = "ResponseMetaData"

name

modelProperties

modelProperties: object

dataSource

dataSource: object

serializedName

serializedName: string = "dataSource"

type

type: object

className

className: string = "DataSource"

name

Const RestoreRequest

RestoreRequest: object

interface: An interface representing RestoreRequest. Description of a restore request.
extends: ProxyOnlyResource

Optional adjustConnectionStrings

adjustConnectionStrings: undefined | false | true

member: {boolean} [adjustConnectionStrings] true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false.

Optional appServicePlan

appServicePlan: undefined | string

member: {string} [appServicePlan] Specify app service plan that will own restored site.

Optional blobName

blobName: undefined | string

member: {string} [blobName] Name of a blob which contains the backup.

Optional databases

databases: DatabaseBackupSetting[]

member: {DatabaseBackupSetting[]} [databases] Collection of databases which should be restored. This list has to match the list of databases included in the backup.

Optional hostingEnvironment

hostingEnvironment: undefined | string

member: {string} [hostingEnvironment] App Service Environment name, if needed (only when restoring an app to an App Service Environment).

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ignoreConflictingHostNames

ignoreConflictingHostNames: undefined | false | true

member: {boolean} [ignoreConflictingHostNames] Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to the app's object when it is being restored, but that might fail due to conflicts during the operation. Default value: false .

Optional ignoreDatabases

ignoreDatabases: undefined | false | true

member: {boolean} [ignoreDatabases] Ignore the databases and only restore the site content. Default value: false .

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationType

operationType: BackupRestoreOperationType

member: {BackupRestoreOperationType} [operationType] Operation type. Possible values include: 'Default', 'Clone', 'Relocation', 'Snapshot', 'CloudFS'. Default value: 'Default' .

overwrite

overwrite: boolean

member: {boolean} overwrite true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app.

serializedName

serializedName: string = "RestoreRequest"

Optional siteName

siteName: undefined | string

member: {string} [siteName] Name of an app.

storageAccountUrl

storageAccountUrl: string

member: {string} storageAccountUrl SAS URL to the container.

type

type: object

className

className: string = "RestoreRequest"

name

modelProperties

type

type: object

name

ignoreDatabases

ignoreDatabases: object

defaultValue

defaultValue: boolean = false

serializedName

serializedName: string = "properties.ignoreDatabases"

type

type: object

name

operationType

operationType: object

defaultValue

defaultValue: string = "Default"

serializedName

serializedName: string = "properties.operationType"

type

type: object

allowedValues

allowedValues: string[] = ["Default","Clone","Relocation","Snapshot","CloudFS"]

name

overwrite

type

type: object

name

Const ServiceSpecification

ServiceSpecification: object

interface: An interface representing ServiceSpecification. Resource metrics service provided by Microsoft.Insights resource provider.

Optional logSpecifications

logSpecifications: LogSpecification[]

member: {LogSpecification[]} [logSpecifications]

Optional metricSpecifications

metricSpecifications: MetricSpecification[]

member: {MetricSpecification[]} [metricSpecifications]

serializedName

serializedName: string = "ServiceSpecification"

type

type: object

className

className: string = "ServiceSpecification"

name

modelProperties

name

Const Site

Site: object

interface: An interface representing Site. A web app, a mobile app backend, or an API app.
extends: Resource

Optional availabilityState

availabilityState: SiteAvailabilityState

member: {SiteAvailabilityState} [availabilityState] Management information availability state for the app. Possible values include: 'Normal', 'Limited', 'DisasterRecoveryMode' NOTE: This property will not be serialized. It can only be populated by the server.

Optional clientAffinityEnabled

clientAffinityEnabled: undefined | false | true

member: {boolean} [clientAffinityEnabled] true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

Optional clientCertEnabled

clientCertEnabled: undefined | false | true

member: {boolean} [clientCertEnabled] true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

Optional cloningInfo

cloningInfo: CloningInfo

member: {CloningInfo} [cloningInfo] If specified during app creation, the app is cloned from a source app.

Optional containerSize

containerSize: undefined | number

member: {number} [containerSize] Size of the function container.

Optional dailyMemoryTimeQuota

dailyMemoryTimeQuota: undefined | number

member: {number} [dailyMemoryTimeQuota] Maximum allowed daily memory-time quota (applicable on dynamic apps only).

Optional defaultHostName

defaultHostName: undefined | string

member: {string} [defaultHostName] Default hostname of the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enabled

enabled: undefined | false | true

member: {boolean} [enabled] true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

Optional enabledHostNames

enabledHostNames: string[]

member: {string[]} [enabledHostNames] Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostNameSslStates

hostNameSslStates: HostNameSslState[]

member: {HostNameSslState[]} [hostNameSslStates] Hostname SSL states are used to manage the SSL bindings for app's hostnames.

Optional hostNames

hostNames: string[]

member: {string[]} [hostNames] Hostnames associated with the app. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostNamesDisabled

hostNamesDisabled: undefined | false | true

member: {boolean} [hostNamesDisabled] true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

member: {HostingEnvironmentProfile} [hostingEnvironmentProfile] App Service Environment to use for the app.

Optional httpsOnly

httpsOnly: undefined | false | true

member: {boolean} [httpsOnly] HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

Optional hyperV

hyperV: undefined | false | true

member: {boolean} [hyperV] Hyper-V sandbox. Default value: false .

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional identity

identity: ManagedServiceIdentity

member: {ManagedServiceIdentity} [identity]

Optional isDefaultContainer

isDefaultContainer: undefined | false | true

member: {boolean} [isDefaultContainer] true if the app is a default container; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isXenon

isXenon: undefined | false | true

member: {boolean} [isXenon] Obsolete: Hyper-V sandbox. Default value: false .

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional lastModifiedTimeUtc

lastModifiedTimeUtc: Date

member: {Date} [lastModifiedTimeUtc] Last time the app was modified, in UTC. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

location

location: string

member: {string} location Resource Location.

Optional maxNumberOfWorkers

maxNumberOfWorkers: undefined | number

member: {number} [maxNumberOfWorkers] Maximum number of workers. This only applies to Functions container. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outboundIpAddresses

outboundIpAddresses: undefined | string

member: {string} [outboundIpAddresses] List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional possibleOutboundIpAddresses

possibleOutboundIpAddresses: undefined | string

member: {string} [possibleOutboundIpAddresses] List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional repositorySiteName

repositorySiteName: undefined | string

member: {string} [repositorySiteName] Name of the repository site. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reserved

reserved: undefined | false | true

member: {boolean} [reserved] true if reserved; otherwise, false. Default value: false .

Optional resourceGroup

resourceGroup: undefined | string

member: {string} [resourceGroup] Name of the resource group the app belongs to. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scmSiteAlsoStopped

scmSiteAlsoStopped: undefined | false | true

member: {boolean} [scmSiteAlsoStopped] true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. Default value: false .

serializedName

serializedName: string = "Site"

Optional serverFarmId

serverFarmId: undefined | string

member: {string} [serverFarmId] Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

Optional siteConfig

siteConfig: SiteConfig

member: {SiteConfig} [siteConfig] Configuration of the app.

Optional slotSwapStatus

slotSwapStatus: SlotSwapStatus

member: {SlotSwapStatus} [slotSwapStatus] Status of the last deployment slot swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state: undefined | string

member: {string} [state] Current state of the app. NOTE: This property will not be serialized. It can only be populated by the server.

Optional suspendedTill

suspendedTill: Date

member: {Date} [suspendedTill] App suspended till in case memory-time quota is exceeded. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

member: {{ [propertyName: string]: string }} [tags] Resource tags.

Optional targetSwapSlot

targetSwapSlot: undefined | string

member: {string} [targetSwapSlot] Specifies which deployment slot this app will swap into. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional trafficManagerHostNames

trafficManagerHostNames: string[]

member: {string[]} [trafficManagerHostNames] Azure Traffic Manager hostnames associated with the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional usageState

usageState: UsageState

member: {UsageState} [usageState] State indicating whether the app has exceeded its quota usage. Read-only. Possible values include: 'Normal', 'Exceeded' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "Site"

name

modelProperties

modelProperties: object

availabilityState

availabilityState: object

readOnly

serverFarmId: object

serializedName

serializedName: string = "properties.serverFarmId"

type

type: object

name

siteConfig

siteConfig: object

serializedName

serializedName: string = "properties.siteConfig"

type

type: object

className

className: string = "SiteConfig"

name

slotSwapStatus

name

element

element: object

type

type: object

name

usageState

usageState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.usageState"

type

type: object

allowedValues

allowedValues: string[] = ["Normal","Exceeded"]

name

Const SiteAuthSettings

SiteAuthSettings: object

interface: An interface representing SiteAuthSettings. Configuration settings for the Azure App Service Authentication / Authorization feature.
extends: ProxyOnlyResource

Optional additionalLoginParams

additionalLoginParams: string[]

member: {string[]} [additionalLoginParams] Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form "key=value".

Optional allowedAudiences

allowedAudiences: string[]

member: {string[]} [allowedAudiences] Allowed audience values to consider when validating JWTs issued by Azure Active Directory. Note that the ClientID value is always considered an allowed audience, regardless of this setting.

Optional allowedExternalRedirectUrls

allowedExternalRedirectUrls: string[]

member: {string[]} [allowedExternalRedirectUrls] External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. This is an advanced setting typically only needed by Windows Store application backends. Note that URLs within the current domain are always implicitly allowed.

Optional clientId

clientId: undefined | string

member: {string} [clientId] The Client ID of this relying party application, known as the client_id. This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html

Optional clientSecret

clientSecret: undefined | string

member: {string} [clientSecret] The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key). This setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users. Otherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users. More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html

Optional defaultProvider

defaultProvider: BuiltInAuthenticationProvider

member: {BuiltInAuthenticationProvider} [defaultProvider] The default authentication provider to use when multiple providers are configured. This setting is only needed if multiple providers are configured and the unauthenticated client action is set to "RedirectToLoginPage". Possible values include: 'AzureActiveDirectory', 'Facebook', 'Google', 'MicrosoftAccount', 'Twitter'

Optional enabled

enabled: undefined | false | true

member: {boolean} [enabled] true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.

Optional facebookAppId

facebookAppId: undefined | string

member: {string} [facebookAppId] The App ID of the Facebook app used for login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login

Optional facebookAppSecret

facebookAppSecret: undefined | string

member: {string} [facebookAppSecret] The App Secret of the Facebook app used for Facebook Login. This setting is required for enabling Facebook Login. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login

Optional facebookOAuthScopes

facebookOAuthScopes: string[]

member: {string[]} [facebookOAuthScopes] The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. This setting is optional. Facebook Login documentation: https://developers.facebook.com/docs/facebook-login

Optional googleClientId

googleClientId: undefined | string

member: {string} [googleClientId] The OpenID Connect Client ID for the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/

Optional googleClientSecret

googleClientSecret: undefined | string

member: {string} [googleClientSecret] The client secret associated with the Google web application. This setting is required for enabling Google Sign-In. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/

Optional googleOAuthScopes

googleOAuthScopes: string[]

member: {string[]} [googleOAuthScopes] The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. This setting is optional. If not specified, "openid", "profile", and "email" are used as default scopes. Google Sign-In documentation: https://developers.google.com/identity/sign-in/web/

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional issuer

issuer: undefined | string

member: {string} [issuer] The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/. This URI is a case-sensitive identifier for the token issuer. More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional microsoftAccountClientId

microsoftAccountClientId: undefined | string

member: {string} [microsoftAccountClientId] The OAuth 2.0 client ID that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm

Optional microsoftAccountClientSecret

microsoftAccountClientSecret: undefined | string

member: {string} [microsoftAccountClientSecret] The OAuth 2.0 client secret that was created for the app used for authentication. This setting is required for enabling Microsoft Account authentication. Microsoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm

Optional microsoftAccountOAuthScopes

microsoftAccountOAuthScopes: string[]

member: {string[]} [microsoftAccountOAuthScopes] The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. This setting is optional. If not specified, "wl.basic" is used as the default scope. Microsoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runtimeVersion

runtimeVersion: undefined | string

member: {string} [runtimeVersion] The RuntimeVersion of the Authentication / Authorization feature in use for the current app. The setting in this value can control the behavior of certain features in the Authentication / Authorization module.

serializedName

serializedName: string = "SiteAuthSettings"

Optional tokenRefreshExtensionHours

tokenRefreshExtensionHours: undefined | number

member: {number} [tokenRefreshExtensionHours] The number of hours after session token expiration that a session token can be used to call the token refresh API. The default is 72 hours.

Optional tokenStoreEnabled

tokenStoreEnabled: undefined | false | true

member: {boolean} [tokenStoreEnabled] true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. The default is false.

Optional twitterConsumerKey

twitterConsumerKey: undefined | string

member: {string} [twitterConsumerKey] The OAuth 1.0a consumer key of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in

Optional twitterConsumerSecret

twitterConsumerSecret: undefined | string

member: {string} [twitterConsumerSecret] The OAuth 1.0a consumer secret of the Twitter application used for sign-in. This setting is required for enabling Twitter Sign-In. Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in

Optional unauthenticatedClientAction

unauthenticatedClientAction: UnauthenticatedClientAction

member: {UnauthenticatedClientAction} [unauthenticatedClientAction] The action to take when an unauthenticated client attempts to access the app. Possible values include: 'RedirectToLoginPage', 'AllowAnonymous'

Optional validateIssuer

validateIssuer: undefined | false | true

member: {boolean} [validateIssuer] Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.

type

type: object

className

className: string = "SiteAuthSettings"

name

modelProperties

serializedName: string = "properties.unauthenticatedClientAction"

type

type: object

allowedValues

allowedValues: string[] = ["RedirectToLoginPage","AllowAnonymous"]

name

validateIssuer

validateIssuer: object

serializedName

serializedName: string = "properties.validateIssuer"

type

type: object

name

Const SiteCloneability

SiteCloneability: object

interface: An interface representing SiteCloneability. Represents whether or not an app is cloneable.

Optional blockingCharacteristics

blockingCharacteristics: SiteCloneabilityCriterion[]

member: {SiteCloneabilityCriterion[]} [blockingCharacteristics] List of blocking application characteristics.

Optional blockingFeatures

blockingFeatures: SiteCloneabilityCriterion[]

member: {SiteCloneabilityCriterion[]} [blockingFeatures] List of features enabled on app that prevent cloning.

Optional result

result: CloneAbilityResult

member: {CloneAbilityResult} [result] Name of app. Possible values include: 'Cloneable', 'PartiallyCloneable', 'NotCloneable'

serializedName

serializedName: string = "SiteCloneability"

Optional unsupportedFeatures

unsupportedFeatures: SiteCloneabilityCriterion[]

member: {SiteCloneabilityCriterion[]} [unsupportedFeatures] List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned but the features in this list will not be set up on cloned app.

type

type: object

className

className: string = "SiteCloneability"

name

modelProperties

allowedValues

allowedValues: string[] = ["Cloneable","PartiallyCloneable","NotCloneable"]

name

unsupportedFeatures

unsupportedFeatures: object

serializedName

serializedName: string = "unsupportedFeatures"

type

type: object

name

element

element: object

type

type: object

className

className: string = "SiteCloneabilityCriterion"

name

Const SiteCloneabilityCriterion

SiteCloneabilityCriterion: object

interface: An interface representing SiteCloneabilityCriterion. An app cloneability criterion.

Optional description

description: undefined | string

member: {string} [description] Description of criterion.

Optional name

member: {string} [name] Name of criterion.

serializedName

serializedName: string = "SiteCloneabilityCriterion"

type

type: object

className

className: string = "SiteCloneabilityCriterion"

name

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name

serializedName

serializedName: string = "name"

type

type: object

name

Const SiteConfig

SiteConfig: object

interface: An interface representing SiteConfig. Configuration of an App Service app.

Optional alwaysOn

alwaysOn: undefined | false | true

member: {boolean} [alwaysOn] true if Always On is enabled; otherwise, false.

Optional apiDefinition

apiDefinition: ApiDefinitionInfo

member: {ApiDefinitionInfo} [apiDefinition] Information about the formal API definition for the app.

Optional appCommandLine

appCommandLine: undefined | string

member: {string} [appCommandLine] App command line to launch.

Optional appSettings

appSettings: NameValuePair[]

member: {NameValuePair[]} [appSettings] Application settings.

Optional autoHealEnabled

autoHealEnabled: undefined | false | true

member: {boolean} [autoHealEnabled] true if Auto Heal is enabled; otherwise, false.

Optional autoHealRules

autoHealRules: AutoHealRules

member: {AutoHealRules} [autoHealRules] Auto Heal rules.

Optional autoSwapSlotName

autoSwapSlotName: undefined | string

member: {string} [autoSwapSlotName] Auto-swap slot name.

Optional azureStorageAccounts

azureStorageAccounts: undefined | object

member: {{ [propertyName: string]: AzureStorageInfoValue }} [azureStorageAccounts] User-provided Azure storage accounts.

Optional connectionStrings

connectionStrings: ConnStringInfo[]

member: {ConnStringInfo[]} [connectionStrings] Connection strings.

Optional cors

cors: CorsSettings

member: {CorsSettings} [cors] Cross-Origin Resource Sharing (CORS) settings.

Optional defaultDocuments

defaultDocuments: string[]

member: {string[]} [defaultDocuments] Default documents.

Optional detailedErrorLoggingEnabled

detailedErrorLoggingEnabled: undefined | false | true

member: {boolean} [detailedErrorLoggingEnabled] true if detailed error logging is enabled; otherwise, false.

Optional documentRoot

documentRoot: undefined | string

member: {string} [documentRoot] Document root.

Optional experiments

experiments: Experiments

member: {Experiments} [experiments] This is work around for polymophic types.

Optional ftpsState

ftpsState: FtpsState

member: {FtpsState} [ftpsState] State of FTP / FTPS service. Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'

Optional handlerMappings

handlerMappings: HandlerMapping[]

member: {HandlerMapping[]} [handlerMappings] Handler mappings.

Optional http20Enabled

http20Enabled: undefined | false | true

member: {boolean} [http20Enabled] Http20Enabled: configures a web site to allow clients to connect over http2.0. Default value: true .

Optional httpLoggingEnabled

httpLoggingEnabled: undefined | false | true

member: {boolean} [httpLoggingEnabled] true if HTTP logging is enabled; otherwise, false.

Optional ipSecurityRestrictions

ipSecurityRestrictions: IpSecurityRestriction[]

member: {IpSecurityRestriction[]} [ipSecurityRestrictions] IP security restrictions.

Optional javaContainer

javaContainer: undefined | string

member: {string} [javaContainer] Java container.

Optional javaContainerVersion

javaContainerVersion: undefined | string

member: {string} [javaContainerVersion] Java container version.

Optional javaVersion

javaVersion: undefined | string

member: {string} [javaVersion] Java version.

Optional limits

limits: SiteLimits

member: {SiteLimits} [limits] Site limits.

Optional linuxFxVersion

linuxFxVersion: undefined | string

member: {string} [linuxFxVersion] Linux App Framework and version

Optional loadBalancing

loadBalancing: SiteLoadBalancing

member: {SiteLoadBalancing} [loadBalancing] Site load balancing. Possible values include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash'

Optional localMySqlEnabled

localMySqlEnabled: undefined | false | true

member: {boolean} [localMySqlEnabled] true to enable local MySQL; otherwise, false. Default value: false .

Optional logsDirectorySizeLimit

logsDirectorySizeLimit: undefined | number

member: {number} [logsDirectorySizeLimit] HTTP logs directory size limit.

Optional machineKey

machineKey: SiteMachineKey

member: {SiteMachineKey} [machineKey] Site MachineKey. NOTE: This property will not be serialized. It can only be populated by the server.

Optional managedPipelineMode

managedPipelineMode: ManagedPipelineMode

member: {ManagedPipelineMode} [managedPipelineMode] Managed pipeline mode. Possible values include: 'Integrated', 'Classic'

Optional managedServiceIdentityId

managedServiceIdentityId: undefined | number

member: {number} [managedServiceIdentityId] Managed Service Identity Id

Optional minTlsVersion

minTlsVersion: SupportedTlsVersions

member: {SupportedTlsVersions} [minTlsVersion] MinTlsVersion: configures the minimum version of TLS required for SSL requests. Possible values include: '1.0', '1.1', '1.2'

Optional netFrameworkVersion

netFrameworkVersion: undefined | string

member: {string} [netFrameworkVersion] .NET Framework version. Default value: 'v4.6' .

Optional nodeVersion

nodeVersion: undefined | string

member: {string} [nodeVersion] Version of Node.js.

Optional numberOfWorkers

numberOfWorkers: undefined | number

member: {number} [numberOfWorkers] Number of workers.

Optional phpVersion

phpVersion: undefined | string

member: {string} [phpVersion] Version of PHP.

Optional publishingUsername

publishingUsername: undefined | string

member: {string} [publishingUsername] Publishing user name.

Optional push

push: PushSettings

member: {PushSettings} [push] Push endpoint settings.

Optional pythonVersion

pythonVersion: undefined | string

member: {string} [pythonVersion] Version of Python.

Optional remoteDebuggingEnabled

remoteDebuggingEnabled: undefined | false | true

member: {boolean} [remoteDebuggingEnabled] true if remote debugging is enabled; otherwise, false.

Optional remoteDebuggingVersion

remoteDebuggingVersion: undefined | string

member: {string} [remoteDebuggingVersion] Remote debugging version.

Optional requestTracingEnabled

requestTracingEnabled: undefined | false | true

member: {boolean} [requestTracingEnabled] true if request tracing is enabled; otherwise, false.

Optional requestTracingExpirationTime

requestTracingExpirationTime: Date

member: {Date} [requestTracingExpirationTime] Request tracing expiration time.

Optional reservedInstanceCount

reservedInstanceCount: undefined | number

member: {number} [reservedInstanceCount] Number of reserved instances. This setting only applies to the Consumption Plan

Optional scmType

scmType: ScmType

member: {ScmType} [scmType] SCM type. Possible values include: 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive', 'VSO'

serializedName

serializedName: string = "SiteConfig"

Optional tracingOptions

tracingOptions: undefined | string

member: {string} [tracingOptions] Tracing options.

Optional use32BitWorkerProcess

use32BitWorkerProcess: undefined | false | true

member: {boolean} [use32BitWorkerProcess] true to use 32-bit worker process; otherwise, false.

Optional virtualApplications

virtualApplications: VirtualApplication[]

member: {VirtualApplication[]} [virtualApplications] Virtual applications.

Optional vnetName

vnetName: undefined | string

member: {string} [vnetName] Virtual Network name.

Optional webSocketsEnabled

webSocketsEnabled: undefined | false | true

member: {boolean} [webSocketsEnabled] true if WebSocket is enabled; otherwise, false.

Optional windowsFxVersion

windowsFxVersion: undefined | string

member: {string} [windowsFxVersion] Xenon App Framework and version

Optional xManagedServiceIdentityId

xManagedServiceIdentityId: undefined | number

member: {number} [xManagedServiceIdentityId] Explicit Managed Service Identity Id

type

type: object

className

className: string = "SiteConfig"

name

modelProperties

modelProperties: object

alwaysOn

alwaysOn: object

serializedName

serializedName: string = "alwaysOn"

type

type: object

name

apiDefinition

type

type: object

className

className: string = "CorsSettings"

name

defaultDocuments

defaultDocuments: object

serializedName

serializedName: string = "defaultDocuments"

type

type: object

type

type: object

className

className: string = "SiteLimits"

name

linuxFxVersion

linuxFxVersion: object

serializedName

serializedName: string = "linuxFxVersion"

type

type: object

minTlsVersion: object

serializedName

serializedName: string = "minTlsVersion"

type

type: object

name

netFrameworkVersion

constraints

name

Const SiteConfigResource

SiteConfigResource: object

interface: An interface representing SiteConfigResource. Web app configuration ARM resource.
extends: ProxyOnlyResource

Optional alwaysOn

alwaysOn: undefined | false | true

member: {boolean} [alwaysOn] true if Always On is enabled; otherwise, false.

Optional apiDefinition

apiDefinition: ApiDefinitionInfo

member: {ApiDefinitionInfo} [apiDefinition] Information about the formal API definition for the app.

Optional appCommandLine

appCommandLine: undefined | string

member: {string} [appCommandLine] App command line to launch.

Optional appSettings

appSettings: NameValuePair[]

member: {NameValuePair[]} [appSettings] Application settings.

Optional autoHealEnabled

autoHealEnabled: undefined | false | true

member: {boolean} [autoHealEnabled] true if Auto Heal is enabled; otherwise, false.

Optional autoHealRules

autoHealRules: AutoHealRules

member: {AutoHealRules} [autoHealRules] Auto Heal rules.

Optional autoSwapSlotName

autoSwapSlotName: undefined | string

member: {string} [autoSwapSlotName] Auto-swap slot name.

Optional azureStorageAccounts

azureStorageAccounts: undefined | object

member: {{ [propertyName: string]: AzureStorageInfoValue }} [azureStorageAccounts] User-provided Azure storage accounts.

Optional connectionStrings

connectionStrings: ConnStringInfo[]

member: {ConnStringInfo[]} [connectionStrings] Connection strings.

Optional cors

cors: CorsSettings

member: {CorsSettings} [cors] Cross-Origin Resource Sharing (CORS) settings.

Optional defaultDocuments

defaultDocuments: string[]

member: {string[]} [defaultDocuments] Default documents.

Optional detailedErrorLoggingEnabled

detailedErrorLoggingEnabled: undefined | false | true

member: {boolean} [detailedErrorLoggingEnabled] true if detailed error logging is enabled; otherwise, false.

Optional documentRoot

documentRoot: undefined | string

member: {string} [documentRoot] Document root.

Optional experiments

experiments: Experiments

member: {Experiments} [experiments] This is work around for polymophic types.

Optional ftpsState

ftpsState: FtpsState

member: {FtpsState} [ftpsState] State of FTP / FTPS service. Possible values include: 'AllAllowed', 'FtpsOnly', 'Disabled'

Optional handlerMappings

handlerMappings: HandlerMapping[]

member: {HandlerMapping[]} [handlerMappings] Handler mappings.

Optional http20Enabled

http20Enabled: undefined | false | true

member: {boolean} [http20Enabled] Http20Enabled: configures a web site to allow clients to connect over http2.0. Default value: true .

Optional httpLoggingEnabled

httpLoggingEnabled: undefined | false | true

member: {boolean} [httpLoggingEnabled] true if HTTP logging is enabled; otherwise, false.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ipSecurityRestrictions

ipSecurityRestrictions: IpSecurityRestriction[]

member: {IpSecurityRestriction[]} [ipSecurityRestrictions] IP security restrictions.

Optional javaContainer

javaContainer: undefined | string

member: {string} [javaContainer] Java container.

Optional javaContainerVersion

javaContainerVersion: undefined | string

member: {string} [javaContainerVersion] Java container version.

Optional javaVersion

javaVersion: undefined | string

member: {string} [javaVersion] Java version.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional limits

limits: SiteLimits

member: {SiteLimits} [limits] Site limits.

Optional linuxFxVersion

linuxFxVersion: undefined | string

member: {string} [linuxFxVersion] Linux App Framework and version

Optional loadBalancing

loadBalancing: SiteLoadBalancing

member: {SiteLoadBalancing} [loadBalancing] Site load balancing. Possible values include: 'WeightedRoundRobin', 'LeastRequests', 'LeastResponseTime', 'WeightedTotalTraffic', 'RequestHash'

Optional localMySqlEnabled

localMySqlEnabled: undefined | false | true

member: {boolean} [localMySqlEnabled] true to enable local MySQL; otherwise, false. Default value: false .

Optional logsDirectorySizeLimit

logsDirectorySizeLimit: undefined | number

member: {number} [logsDirectorySizeLimit] HTTP logs directory size limit.

Optional machineKey

machineKey: SiteMachineKey

member: {SiteMachineKey} [machineKey] Site MachineKey. NOTE: This property will not be serialized. It can only be populated by the server.

Optional managedPipelineMode

managedPipelineMode: ManagedPipelineMode

member: {ManagedPipelineMode} [managedPipelineMode] Managed pipeline mode. Possible values include: 'Integrated', 'Classic'

Optional managedServiceIdentityId

managedServiceIdentityId: undefined | number

member: {number} [managedServiceIdentityId] Managed Service Identity Id

Optional minTlsVersion

minTlsVersion: SupportedTlsVersions

member: {SupportedTlsVersions} [minTlsVersion] MinTlsVersion: configures the minimum version of TLS required for SSL requests. Possible values include: '1.0', '1.1', '1.2'

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional netFrameworkVersion

netFrameworkVersion: undefined | string

member: {string} [netFrameworkVersion] .NET Framework version. Default value: 'v4.6' .

Optional nodeVersion

nodeVersion: undefined | string

member: {string} [nodeVersion] Version of Node.js.

Optional numberOfWorkers

numberOfWorkers: undefined | number

member: {number} [numberOfWorkers] Number of workers.

Optional phpVersion

phpVersion: undefined | string

member: {string} [phpVersion] Version of PHP.

Optional publishingUsername

publishingUsername: undefined | string

member: {string} [publishingUsername] Publishing user name.

Optional push

push: PushSettings

member: {PushSettings} [push] Push endpoint settings.

Optional pythonVersion

pythonVersion: undefined | string

member: {string} [pythonVersion] Version of Python.

Optional remoteDebuggingEnabled

remoteDebuggingEnabled: undefined | false | true

member: {boolean} [remoteDebuggingEnabled] true if remote debugging is enabled; otherwise, false.

Optional remoteDebuggingVersion

remoteDebuggingVersion: undefined | string

member: {string} [remoteDebuggingVersion] Remote debugging version.

Optional requestTracingEnabled

requestTracingEnabled: undefined | false | true

member: {boolean} [requestTracingEnabled] true if request tracing is enabled; otherwise, false.

Optional requestTracingExpirationTime

requestTracingExpirationTime: Date

member: {Date} [requestTracingExpirationTime] Request tracing expiration time.

Optional reservedInstanceCount

reservedInstanceCount: undefined | number

member: {number} [reservedInstanceCount] Number of reserved instances. This setting only applies to the Consumption Plan

Optional scmType

scmType: ScmType

member: {ScmType} [scmType] SCM type. Possible values include: 'None', 'Dropbox', 'Tfs', 'LocalGit', 'GitHub', 'CodePlexGit', 'CodePlexHg', 'BitbucketGit', 'BitbucketHg', 'ExternalGit', 'ExternalHg', 'OneDrive', 'VSO'

serializedName

serializedName: string = "SiteConfigResource"

Optional tracingOptions

tracingOptions: undefined | string

member: {string} [tracingOptions] Tracing options.

Optional use32BitWorkerProcess

use32BitWorkerProcess: undefined | false | true

member: {boolean} [use32BitWorkerProcess] true to use 32-bit worker process; otherwise, false.

Optional virtualApplications

virtualApplications: VirtualApplication[]

member: {VirtualApplication[]} [virtualApplications] Virtual applications.

Optional vnetName

vnetName: undefined | string

member: {string} [vnetName] Virtual Network name.

Optional webSocketsEnabled

webSocketsEnabled: undefined | false | true

member: {boolean} [webSocketsEnabled] true if WebSocket is enabled; otherwise, false.

Optional windowsFxVersion

windowsFxVersion: undefined | string

member: {string} [windowsFxVersion] Xenon App Framework and version

Optional xManagedServiceIdentityId

xManagedServiceIdentityId: undefined | number

member: {number} [xManagedServiceIdentityId] Explicit Managed Service Identity Id

type

type: object

className

className: string = "SiteConfigResource"

name

modelProperties

modelProperties: object

alwaysOn

alwaysOn: object

serializedName

serializedName: string = "properties.alwaysOn"

type

type: object

name

apiDefinition

type

type: object

className

className: string = "CorsSettings"

name

defaultDocuments

defaultDocuments: object

serializedName

serializedName: string = "properties.defaultDocuments"

type

type: object

type

type: object

className

className: string = "SiteLimits"

name

linuxFxVersion

linuxFxVersion: object

serializedName

serializedName: string = "properties.linuxFxVersion"

type

type: object

minTlsVersion: object

serializedName

serializedName: string = "properties.minTlsVersion"

type

type: object

name

netFrameworkVersion

constraints

name

Const SiteConfigResourceCollection

SiteConfigResourceCollection: object

interface: An interface representing the SiteConfigResourceCollection. Collection of site configurations.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteConfigResourceCollection"

__@iterator

__@iterator(): IterableIterator<SiteConfigResource>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<SiteConfigResource>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<SiteConfigResource>[]): SiteConfigResource[]
concat(...items: (T | ConcatArray<T>)[]): SiteConfigResource[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<SiteConfigResource>[]
 
 Additional items to add to the end of array1.
Returns SiteConfigResource[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns SiteConfigResource[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, SiteConfigResource]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, SiteConfigResource]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: SiteConfigResource, index: number, array: SiteConfigResource[]): boolean
    - Parameters
      - value: SiteConfigResource
      - index: number
      - array: SiteConfigResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: SiteConfigResource, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: SiteConfigResource
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): SiteConfigResource[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: SiteConfigResource
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SiteConfigResource, index: number, array: SiteConfigResource[]): boolean
    - Parameters
      - value: SiteConfigResource
      - index: number
      - array: SiteConfigResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SiteConfigResource, index: number, array: SiteConfigResource[]): any
    - Parameters
      - value: SiteConfigResource
      - index: number
      - array: SiteConfigResource[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns SiteConfigResource[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): SiteConfigResource | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: SiteConfigResource
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: SiteConfigResource, index: number, obj: SiteConfigResource[]): boolean
    - Parameters
      - this: void
      - value: SiteConfigResource
      - index: number
      - obj: SiteConfigResource[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: SiteConfigResource, index: number, obj: SiteConfigResource[]): boolean
    - Parameters
      - value: SiteConfigResource
      - index: number
      - obj: SiteConfigResource[]
      Returns boolean
- Optional thisArg: any
Returns SiteConfigResource | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: SiteConfigResource, index: number, obj: SiteConfigResource[]): boolean
    - Parameters
      - value: SiteConfigResource
      - index: number
      - obj: SiteConfigResource[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: SiteConfigResource, index: number, array: SiteConfigResource[]): void
    - Parameters
      - value: SiteConfigResource
      - index: number
      - array: SiteConfigResource[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: SiteConfigResource, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: SiteConfigResource
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: SiteConfigResource, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: SiteConfigResource
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: SiteConfigResource, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: SiteConfigResource
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: SiteConfigResource, index: number, array: SiteConfigResource[]): U
    - Parameters
      - value: SiteConfigResource
      - index: number
      - array: SiteConfigResource[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): SiteConfigResource | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns SiteConfigResource | undefined

push

push(...items: SiteConfigResource[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: SiteConfigResource[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): SiteConfigResource
reduce(callbackfn: function, initialValue: SiteConfigResource): SiteConfigResource
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SiteConfigResource, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): SiteConfigResource
    - Parameters
      - previousValue: SiteConfigResource
      - currentValue: SiteConfigResource
      - currentIndex: number
      - array: SiteConfigResource[]
      Returns SiteConfigResource
Returns SiteConfigResource
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: SiteConfigResource, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): SiteConfigResource
    - Parameters
      - previousValue: SiteConfigResource
      - currentValue: SiteConfigResource
      - currentIndex: number
      - array: SiteConfigResource[]
      Returns SiteConfigResource
- initialValue: SiteConfigResource
Returns SiteConfigResource
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): U
    - Parameters
      - previousValue: U
      - currentValue: SiteConfigResource
      - currentIndex: number
      - array: SiteConfigResource[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): SiteConfigResource
reduceRight(callbackfn: function, initialValue: SiteConfigResource): SiteConfigResource
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SiteConfigResource, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): SiteConfigResource
    - Parameters
      - previousValue: SiteConfigResource
      - currentValue: SiteConfigResource
      - currentIndex: number
      - array: SiteConfigResource[]
      Returns SiteConfigResource
Returns SiteConfigResource
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: SiteConfigResource, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): SiteConfigResource
    - Parameters
      - previousValue: SiteConfigResource
      - currentValue: SiteConfigResource
      - currentIndex: number
      - array: SiteConfigResource[]
      Returns SiteConfigResource
- initialValue: SiteConfigResource
Returns SiteConfigResource
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SiteConfigResource, currentIndex: number, array: SiteConfigResource[]): U
    - Parameters
      - previousValue: U
      - currentValue: SiteConfigResource
      - currentIndex: number
      - array: SiteConfigResource[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): SiteConfigResource[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns SiteConfigResource[]

shift

shift(): SiteConfigResource | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns SiteConfigResource | undefined

slice

slice(start?: undefined | number, end?: undefined | number): SiteConfigResource[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns SiteConfigResource[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: SiteConfigResource, index: number, array: SiteConfigResource[]): boolean
    - Parameters
      - value: SiteConfigResource
      - index: number
      - array: SiteConfigResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): SiteConfigResource[]
splice(start: number, deleteCount: number, ...items: SiteConfigResource[]): SiteConfigResource[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns SiteConfigResource[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: SiteConfigResource[]
  
  Elements to insert into the array in place of the deleted elements.
Returns SiteConfigResource[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: SiteConfigResource[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: SiteConfigResource[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<SiteConfigResource>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<SiteConfigResource>

type

type: object

className

className: string = "SiteConfigResourceCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "SiteConfigResource"

name

Const SiteConfigurationSnapshotInfo

SiteConfigurationSnapshotInfo: object

interface: An interface representing SiteConfigurationSnapshotInfo. A snapshot of a web app configuration.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteConfigurationSnapshotInfo"

Optional snapshotId

snapshotId: undefined | number

member: {number} [snapshotId] The id of the snapshot NOTE: This property will not be serialized. It can only be populated by the server.

Optional time

time: Date

member: {Date} [time] The time the snapshot was taken. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SiteConfigurationSnapshotInfo"

name

modelProperties

modelProperties: object

snapshotId

snapshotId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.snapshotId"

type

type: object

name

time

time: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.time"

type

type: object

name

Const SiteConfigurationSnapshotInfoCollection

SiteConfigurationSnapshotInfoCollection: object

interface: An interface representing the SiteConfigurationSnapshotInfoCollection. Collection of metadata for the app configuration snapshots that can be restored.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteConfigurationSnapshotInfoCollection"

__@iterator

__@iterator(): IterableIterator<SiteConfigurationSnapshotInfo>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<SiteConfigurationSnapshotInfo>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<SiteConfigurationSnapshotInfo>[]): SiteConfigurationSnapshotInfo[]
concat(...items: (T | ConcatArray<T>)[]): SiteConfigurationSnapshotInfo[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<SiteConfigurationSnapshotInfo>[]
 
 Additional items to add to the end of array1.
Returns SiteConfigurationSnapshotInfo[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns SiteConfigurationSnapshotInfo[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, SiteConfigurationSnapshotInfo]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, SiteConfigurationSnapshotInfo]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): boolean
    - Parameters
      - value: SiteConfigurationSnapshotInfo
      - index: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: SiteConfigurationSnapshotInfo, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: SiteConfigurationSnapshotInfo
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): SiteConfigurationSnapshotInfo[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: SiteConfigurationSnapshotInfo
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): boolean
    - Parameters
      - value: SiteConfigurationSnapshotInfo
      - index: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): any
    - Parameters
      - value: SiteConfigurationSnapshotInfo
      - index: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns SiteConfigurationSnapshotInfo[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): SiteConfigurationSnapshotInfo | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: SiteConfigurationSnapshotInfo
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: SiteConfigurationSnapshotInfo, index: number, obj: SiteConfigurationSnapshotInfo[]): boolean
    - Parameters
      - this: void
      - value: SiteConfigurationSnapshotInfo
      - index: number
      - obj: SiteConfigurationSnapshotInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: SiteConfigurationSnapshotInfo, index: number, obj: SiteConfigurationSnapshotInfo[]): boolean
    - Parameters
      - value: SiteConfigurationSnapshotInfo
      - index: number
      - obj: SiteConfigurationSnapshotInfo[]
      Returns boolean
- Optional thisArg: any
Returns SiteConfigurationSnapshotInfo | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: SiteConfigurationSnapshotInfo, index: number, obj: SiteConfigurationSnapshotInfo[]): boolean
    - Parameters
      - value: SiteConfigurationSnapshotInfo
      - index: number
      - obj: SiteConfigurationSnapshotInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): void
    - Parameters
      - value: SiteConfigurationSnapshotInfo
      - index: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: SiteConfigurationSnapshotInfo, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: SiteConfigurationSnapshotInfo
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: SiteConfigurationSnapshotInfo, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: SiteConfigurationSnapshotInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: SiteConfigurationSnapshotInfo, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: SiteConfigurationSnapshotInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): U
    - Parameters
      - value: SiteConfigurationSnapshotInfo
      - index: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): SiteConfigurationSnapshotInfo | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns SiteConfigurationSnapshotInfo | undefined

push

push(...items: SiteConfigurationSnapshotInfo[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: SiteConfigurationSnapshotInfo[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): SiteConfigurationSnapshotInfo
reduce(callbackfn: function, initialValue: SiteConfigurationSnapshotInfo): SiteConfigurationSnapshotInfo
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SiteConfigurationSnapshotInfo, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): SiteConfigurationSnapshotInfo
    - Parameters
      - previousValue: SiteConfigurationSnapshotInfo
      - currentValue: SiteConfigurationSnapshotInfo
      - currentIndex: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns SiteConfigurationSnapshotInfo
Returns SiteConfigurationSnapshotInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: SiteConfigurationSnapshotInfo, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): SiteConfigurationSnapshotInfo
    - Parameters
      - previousValue: SiteConfigurationSnapshotInfo
      - currentValue: SiteConfigurationSnapshotInfo
      - currentIndex: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns SiteConfigurationSnapshotInfo
- initialValue: SiteConfigurationSnapshotInfo
Returns SiteConfigurationSnapshotInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: SiteConfigurationSnapshotInfo
      - currentIndex: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): SiteConfigurationSnapshotInfo
reduceRight(callbackfn: function, initialValue: SiteConfigurationSnapshotInfo): SiteConfigurationSnapshotInfo
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SiteConfigurationSnapshotInfo, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): SiteConfigurationSnapshotInfo
    - Parameters
      - previousValue: SiteConfigurationSnapshotInfo
      - currentValue: SiteConfigurationSnapshotInfo
      - currentIndex: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns SiteConfigurationSnapshotInfo
Returns SiteConfigurationSnapshotInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: SiteConfigurationSnapshotInfo, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): SiteConfigurationSnapshotInfo
    - Parameters
      - previousValue: SiteConfigurationSnapshotInfo
      - currentValue: SiteConfigurationSnapshotInfo
      - currentIndex: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns SiteConfigurationSnapshotInfo
- initialValue: SiteConfigurationSnapshotInfo
Returns SiteConfigurationSnapshotInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SiteConfigurationSnapshotInfo, currentIndex: number, array: SiteConfigurationSnapshotInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: SiteConfigurationSnapshotInfo
      - currentIndex: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): SiteConfigurationSnapshotInfo[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns SiteConfigurationSnapshotInfo[]

shift

shift(): SiteConfigurationSnapshotInfo | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns SiteConfigurationSnapshotInfo | undefined

slice

slice(start?: undefined | number, end?: undefined | number): SiteConfigurationSnapshotInfo[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns SiteConfigurationSnapshotInfo[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: SiteConfigurationSnapshotInfo, index: number, array: SiteConfigurationSnapshotInfo[]): boolean
    - Parameters
      - value: SiteConfigurationSnapshotInfo
      - index: number
      - array: SiteConfigurationSnapshotInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): SiteConfigurationSnapshotInfo[]
splice(start: number, deleteCount: number, ...items: SiteConfigurationSnapshotInfo[]): SiteConfigurationSnapshotInfo[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns SiteConfigurationSnapshotInfo[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: SiteConfigurationSnapshotInfo[]
  
  Elements to insert into the array in place of the deleted elements.
Returns SiteConfigurationSnapshotInfo[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: SiteConfigurationSnapshotInfo[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: SiteConfigurationSnapshotInfo[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<SiteConfigurationSnapshotInfo>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<SiteConfigurationSnapshotInfo>

type

type: object

className

className: string = "SiteConfigurationSnapshotInfoCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "SiteConfigurationSnapshotInfo"

name

Const SiteExtensionInfo

SiteExtensionInfo: object

interface: An interface representing SiteExtensionInfo. Site Extension Information.
extends: ProxyOnlyResource

Optional authors

authors: string[]

member: {string[]} [authors] List of authors.

Optional comment

comment: undefined | string

member: {string} [comment] Site Extension comment.

Optional description

description: undefined | string

member: {string} [description] Detailed description.

Optional downloadCount

downloadCount: undefined | number

member: {number} [downloadCount] Count of downloads.

Optional extensionId

extensionId: undefined | string

member: {string} [extensionId] Site extension ID.

Optional extensionType

extensionType: SiteExtensionType

member: {SiteExtensionType} [extensionType] Site extension type. Possible values include: 'Gallery', 'WebRoot'

Optional extensionUrl

extensionUrl: undefined | string

member: {string} [extensionUrl] Extension URL.

Optional feedUrl

feedUrl: undefined | string

member: {string} [feedUrl] Feed URL.

Optional iconUrl

iconUrl: undefined | string

member: {string} [iconUrl] Icon URL.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional installedDateTime

installedDateTime: Date

member: {Date} [installedDateTime] Installed timestamp.

Optional installerCommandLineParams

installerCommandLineParams: undefined | string

member: {string} [installerCommandLineParams] Installer command line parameters.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional licenseUrl

licenseUrl: undefined | string

member: {string} [licenseUrl] License URL.

Optional localIsLatestVersion

localIsLatestVersion: undefined | false | true

member: {boolean} [localIsLatestVersion] true if the local version is the latest version; false otherwise.

Optional localPath

localPath: undefined | string

member: {string} [localPath] Local path.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional projectUrl

projectUrl: undefined | string

member: {string} [projectUrl] Project URL.

Optional provisioningState

provisioningState: undefined | string

member: {string} [provisioningState] Provisioning state.

Optional publishedDateTime

publishedDateTime: Date

member: {Date} [publishedDateTime] Published timestamp.

serializedName

serializedName: string = "SiteExtensionInfo"

Optional summary

summary: undefined | string

member: {string} [summary] Summary description.

Optional title

title: undefined | string

member: {string} [title]

Optional version

version: undefined | string

member: {string} [version] Version information.

type

type: object

className

className: string = "SiteExtensionInfo"

name

modelProperties

modelProperties: object

authors

authors: object

serializedName

serializedName: string = "properties.authors"

type

type: object

name

Const SiteExtensionInfoCollection

SiteExtensionInfoCollection: object

interface: An interface representing the SiteExtensionInfoCollection. Collection of Kudu site extension information elements.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteExtensionInfoCollection"

__@iterator

__@iterator(): IterableIterator<SiteExtensionInfo>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<SiteExtensionInfo>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<SiteExtensionInfo>[]): SiteExtensionInfo[]
concat(...items: (T | ConcatArray<T>)[]): SiteExtensionInfo[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<SiteExtensionInfo>[]
 
 Additional items to add to the end of array1.
Returns SiteExtensionInfo[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns SiteExtensionInfo[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, SiteExtensionInfo]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, SiteExtensionInfo]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): boolean
    - Parameters
      - value: SiteExtensionInfo
      - index: number
      - array: SiteExtensionInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: SiteExtensionInfo, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: SiteExtensionInfo
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): SiteExtensionInfo[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: SiteExtensionInfo
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): boolean
    - Parameters
      - value: SiteExtensionInfo
      - index: number
      - array: SiteExtensionInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): any
    - Parameters
      - value: SiteExtensionInfo
      - index: number
      - array: SiteExtensionInfo[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns SiteExtensionInfo[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): SiteExtensionInfo | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: SiteExtensionInfo
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: SiteExtensionInfo, index: number, obj: SiteExtensionInfo[]): boolean
    - Parameters
      - this: void
      - value: SiteExtensionInfo
      - index: number
      - obj: SiteExtensionInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: SiteExtensionInfo, index: number, obj: SiteExtensionInfo[]): boolean
    - Parameters
      - value: SiteExtensionInfo
      - index: number
      - obj: SiteExtensionInfo[]
      Returns boolean
- Optional thisArg: any
Returns SiteExtensionInfo | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: SiteExtensionInfo, index: number, obj: SiteExtensionInfo[]): boolean
    - Parameters
      - value: SiteExtensionInfo
      - index: number
      - obj: SiteExtensionInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): void
    - Parameters
      - value: SiteExtensionInfo
      - index: number
      - array: SiteExtensionInfo[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: SiteExtensionInfo, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: SiteExtensionInfo
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: SiteExtensionInfo, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: SiteExtensionInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: SiteExtensionInfo, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: SiteExtensionInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): U
    - Parameters
      - value: SiteExtensionInfo
      - index: number
      - array: SiteExtensionInfo[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): SiteExtensionInfo | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns SiteExtensionInfo | undefined

push

push(...items: SiteExtensionInfo[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: SiteExtensionInfo[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): SiteExtensionInfo
reduce(callbackfn: function, initialValue: SiteExtensionInfo): SiteExtensionInfo
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SiteExtensionInfo, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): SiteExtensionInfo
    - Parameters
      - previousValue: SiteExtensionInfo
      - currentValue: SiteExtensionInfo
      - currentIndex: number
      - array: SiteExtensionInfo[]
      Returns SiteExtensionInfo
Returns SiteExtensionInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: SiteExtensionInfo, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): SiteExtensionInfo
    - Parameters
      - previousValue: SiteExtensionInfo
      - currentValue: SiteExtensionInfo
      - currentIndex: number
      - array: SiteExtensionInfo[]
      Returns SiteExtensionInfo
- initialValue: SiteExtensionInfo
Returns SiteExtensionInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: SiteExtensionInfo
      - currentIndex: number
      - array: SiteExtensionInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): SiteExtensionInfo
reduceRight(callbackfn: function, initialValue: SiteExtensionInfo): SiteExtensionInfo
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SiteExtensionInfo, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): SiteExtensionInfo
    - Parameters
      - previousValue: SiteExtensionInfo
      - currentValue: SiteExtensionInfo
      - currentIndex: number
      - array: SiteExtensionInfo[]
      Returns SiteExtensionInfo
Returns SiteExtensionInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: SiteExtensionInfo, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): SiteExtensionInfo
    - Parameters
      - previousValue: SiteExtensionInfo
      - currentValue: SiteExtensionInfo
      - currentIndex: number
      - array: SiteExtensionInfo[]
      Returns SiteExtensionInfo
- initialValue: SiteExtensionInfo
Returns SiteExtensionInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SiteExtensionInfo, currentIndex: number, array: SiteExtensionInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: SiteExtensionInfo
      - currentIndex: number
      - array: SiteExtensionInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): SiteExtensionInfo[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns SiteExtensionInfo[]

shift

shift(): SiteExtensionInfo | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns SiteExtensionInfo | undefined

slice

slice(start?: undefined | number, end?: undefined | number): SiteExtensionInfo[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns SiteExtensionInfo[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: SiteExtensionInfo, index: number, array: SiteExtensionInfo[]): boolean
    - Parameters
      - value: SiteExtensionInfo
      - index: number
      - array: SiteExtensionInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): SiteExtensionInfo[]
splice(start: number, deleteCount: number, ...items: SiteExtensionInfo[]): SiteExtensionInfo[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns SiteExtensionInfo[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: SiteExtensionInfo[]
  
  Elements to insert into the array in place of the deleted elements.
Returns SiteExtensionInfo[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: SiteExtensionInfo[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: SiteExtensionInfo[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<SiteExtensionInfo>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<SiteExtensionInfo>

type

type: object

className

className: string = "SiteExtensionInfoCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "SiteExtensionInfo"

name

Const SiteInstance

SiteInstance: object

interface: An interface representing SiteInstance. Instance of an app.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteInstance"

Optional siteInstanceName

siteInstanceName: undefined | string

member: {string} [siteInstanceName] Name of instance. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SiteInstance"

name

modelProperties

modelProperties: object

siteInstanceName

siteInstanceName: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.siteInstanceName"

type

type: object

name

Const SiteLimits

SiteLimits: object

interface: An interface representing SiteLimits. Metric limits set on an app.

Optional maxDiskSizeInMb

maxDiskSizeInMb: undefined | number

member: {number} [maxDiskSizeInMb] Maximum allowed disk size usage in MB.

Optional maxMemoryInMb

maxMemoryInMb: undefined | number

member: {number} [maxMemoryInMb] Maximum allowed memory usage in MB.

Optional maxPercentageCpu

maxPercentageCpu: undefined | number

member: {number} [maxPercentageCpu] Maximum allowed CPU usage percentage.

serializedName

serializedName: string = "SiteLimits"

type

type: object

className

className: string = "SiteLimits"

name

modelProperties

name

Const SiteLogsConfig

SiteLogsConfig: object

interface: An interface representing SiteLogsConfig. Configuration of App Service site logs.
extends: ProxyOnlyResource

Optional applicationLogs

applicationLogs: ApplicationLogsConfig

member: {ApplicationLogsConfig} [applicationLogs] Application logs configuration.

Optional detailedErrorMessages

detailedErrorMessages: EnabledConfig

member: {EnabledConfig} [detailedErrorMessages] Detailed error messages configuration.

Optional failedRequestsTracing

failedRequestsTracing: EnabledConfig

member: {EnabledConfig} [failedRequestsTracing] Failed requests tracing configuration.

Optional httpLogs

httpLogs: HttpLogsConfig

member: {HttpLogsConfig} [httpLogs] HTTP logs configuration.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SiteLogsConfig"

type

type: object

className

className: string = "SiteLogsConfig"

name

modelProperties

name

Const SiteMachineKey

SiteMachineKey: object

interface: An interface representing SiteMachineKey. MachineKey of an app.

Optional decryption

decryption: undefined | string

member: {string} [decryption] Algorithm used for decryption.

Optional decryptionKey

decryptionKey: undefined | string

member: {string} [decryptionKey] Decryption key.

serializedName

serializedName: string = "SiteMachineKey"

Optional validation

validation: undefined | string

member: {string} [validation] MachineKey validation.

Optional validationKey

validationKey: undefined | string

member: {string} [validationKey] Validation key.

type

type: object

className

className: string = "SiteMachineKey"

name

modelProperties

name

Const SitePatchResource

SitePatchResource: object

interface: An interface representing SitePatchResource. ARM resource for a site.
extends: ProxyOnlyResource

Optional availabilityState

availabilityState: SiteAvailabilityState

member: {SiteAvailabilityState} [availabilityState] Management information availability state for the app. Possible values include: 'Normal', 'Limited', 'DisasterRecoveryMode' NOTE: This property will not be serialized. It can only be populated by the server.

Optional clientAffinityEnabled

clientAffinityEnabled: undefined | false | true

member: {boolean} [clientAffinityEnabled] true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.

Optional clientCertEnabled

clientCertEnabled: undefined | false | true

member: {boolean} [clientCertEnabled] true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

Optional cloningInfo

cloningInfo: CloningInfo

member: {CloningInfo} [cloningInfo] If specified during app creation, the app is cloned from a source app.

Optional containerSize

containerSize: undefined | number

member: {number} [containerSize] Size of the function container.

Optional dailyMemoryTimeQuota

dailyMemoryTimeQuota: undefined | number

member: {number} [dailyMemoryTimeQuota] Maximum allowed daily memory-time quota (applicable on dynamic apps only).

Optional defaultHostName

defaultHostName: undefined | string

member: {string} [defaultHostName] Default hostname of the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional enabled

enabled: undefined | false | true

member: {boolean} [enabled] true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

Optional enabledHostNames

enabledHostNames: string[]

member: {string[]} [enabledHostNames] Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostNameSslStates

hostNameSslStates: HostNameSslState[]

member: {HostNameSslState[]} [hostNameSslStates] Hostname SSL states are used to manage the SSL bindings for app's hostnames.

Optional hostNames

hostNames: string[]

member: {string[]} [hostNames] Hostnames associated with the app. NOTE: This property will not be serialized. It can only be populated by the server.

Optional hostNamesDisabled

hostNamesDisabled: undefined | false | true

member: {boolean} [hostNamesDisabled] true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

Optional hostingEnvironmentProfile

hostingEnvironmentProfile: HostingEnvironmentProfile

member: {HostingEnvironmentProfile} [hostingEnvironmentProfile] App Service Environment to use for the app.

Optional httpsOnly

httpsOnly: undefined | false | true

member: {boolean} [httpsOnly] HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

Optional hyperV

hyperV: undefined | false | true

member: {boolean} [hyperV] Hyper-V sandbox. Default value: false .

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isDefaultContainer

isDefaultContainer: undefined | false | true

member: {boolean} [isDefaultContainer] true if the app is a default container; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isXenon

isXenon: undefined | false | true

member: {boolean} [isXenon] Obsolete: Hyper-V sandbox. Default value: false .

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional lastModifiedTimeUtc

lastModifiedTimeUtc: Date

member: {Date} [lastModifiedTimeUtc] Last time the app was modified, in UTC. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional maxNumberOfWorkers

maxNumberOfWorkers: undefined | number

member: {number} [maxNumberOfWorkers] Maximum number of workers. This only applies to Functions container. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outboundIpAddresses

outboundIpAddresses: undefined | string

member: {string} [outboundIpAddresses] List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional possibleOutboundIpAddresses

possibleOutboundIpAddresses: undefined | string

member: {string} [possibleOutboundIpAddresses] List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional repositorySiteName

repositorySiteName: undefined | string

member: {string} [repositorySiteName] Name of the repository site. NOTE: This property will not be serialized. It can only be populated by the server.

Optional reserved

reserved: undefined | false | true

member: {boolean} [reserved] true if reserved; otherwise, false. Default value: false .

Optional resourceGroup

resourceGroup: undefined | string

member: {string} [resourceGroup] Name of the resource group the app belongs to. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scmSiteAlsoStopped

scmSiteAlsoStopped: undefined | false | true

member: {boolean} [scmSiteAlsoStopped] true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. Default value: false .

serializedName

serializedName: string = "SitePatchResource"

Optional serverFarmId

serverFarmId: undefined | string

member: {string} [serverFarmId] Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

Optional siteConfig

siteConfig: SiteConfig

member: {SiteConfig} [siteConfig] Configuration of the app.

Optional slotSwapStatus

slotSwapStatus: SlotSwapStatus

member: {SlotSwapStatus} [slotSwapStatus] Status of the last deployment slot swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

state: undefined | string

member: {string} [state] Current state of the app. NOTE: This property will not be serialized. It can only be populated by the server.

Optional suspendedTill

suspendedTill: Date

member: {Date} [suspendedTill] App suspended till in case memory-time quota is exceeded. NOTE: This property will not be serialized. It can only be populated by the server.

Optional targetSwapSlot

targetSwapSlot: undefined | string

member: {string} [targetSwapSlot] Specifies which deployment slot this app will swap into. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional trafficManagerHostNames

trafficManagerHostNames: string[]

member: {string[]} [trafficManagerHostNames] Azure Traffic Manager hostnames associated with the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Optional usageState

usageState: UsageState

member: {UsageState} [usageState] State indicating whether the app has exceeded its quota usage. Read-only. Possible values include: 'Normal', 'Exceeded' NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SitePatchResource"

name

modelProperties

modelProperties: object

availabilityState

availabilityState: object

readOnly

serverFarmId: object

serializedName

serializedName: string = "properties.serverFarmId"

type

type: object

name

siteConfig

siteConfig: object

serializedName

serializedName: string = "properties.siteConfig"

type

type: object

className

className: string = "SiteConfig"

name

slotSwapStatus

name

element

element: object

type

type: object

name

usageState

usageState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.usageState"

type

type: object

allowedValues

allowedValues: string[] = ["Normal","Exceeded"]

name

Const SitePhpErrorLogFlag

SitePhpErrorLogFlag: object

interface: An interface representing SitePhpErrorLogFlag. Used for getting PHP error logging flag.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional localLogErrors

localLogErrors: undefined | string

member: {string} [localLogErrors] Local log_errors setting.

Optional localLogErrorsMaxLength

localLogErrorsMaxLength: undefined | string

member: {string} [localLogErrorsMaxLength] Local log_errors_max_len setting.

Optional masterLogErrors

masterLogErrors: undefined | string

member: {string} [masterLogErrors] Master log_errors setting.

Optional masterLogErrorsMaxLength

masterLogErrorsMaxLength: undefined | string

member: {string} [masterLogErrorsMaxLength] Master log_errors_max_len setting.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SitePhpErrorLogFlag"

type

type: object

className

className: string = "SitePhpErrorLogFlag"

name

modelProperties

name

Const SiteSeal

SiteSeal: object

interface: An interface representing SiteSeal. Site seal

html

html: string

member: {string} html HTML snippet

serializedName

serializedName: string = "SiteSeal"

type

type: object

className

className: string = "SiteSeal"

name

modelProperties

modelProperties: object

html

html: object

required

required: true = true

serializedName

serializedName: string = "html"

type

type: object

name

Const SiteSealRequest

SiteSealRequest: object

interface: An interface representing SiteSealRequest. Site seal request.

Optional lightTheme

lightTheme: undefined | false | true

member: {boolean} [lightTheme] If true use the light color theme for site seal; otherwise, use the default color theme.

Optional locale

locale: undefined | string

member: {string} [locale] Locale of site seal.

serializedName

serializedName: string = "SiteSealRequest"

type

type: object

className

className: string = "SiteSealRequest"

name

modelProperties

modelProperties: object

lightTheme

lightTheme: object

serializedName

serializedName: string = "lightTheme"

type

type: object

name

locale

locale: object

serializedName

serializedName: string = "locale"

type

type: object

name

Const SiteSourceControl

SiteSourceControl: object

interface: An interface representing SiteSourceControl. Source control configuration for an app.
extends: ProxyOnlyResource

Optional branch

branch: undefined | string

member: {string} [branch] Name of branch to use for deployment.

Optional deploymentRollbackEnabled

deploymentRollbackEnabled: undefined | false | true

member: {boolean} [deploymentRollbackEnabled] true to enable deployment rollback; otherwise, false.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional isManualIntegration

isManualIntegration: undefined | false | true

member: {boolean} [isManualIntegration] true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).

Optional isMercurial

isMercurial: undefined | false | true

member: {boolean} [isMercurial] true for a Mercurial repository; false for a Git repository.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional repoUrl

repoUrl: undefined | string

member: {string} [repoUrl] Repository or source control URL.

serializedName

serializedName: string = "SiteSourceControl"

type

type: object

className

className: string = "SiteSourceControl"

name

modelProperties

name

Const SkuCapacity

SkuCapacity: object

interface: An interface representing SkuCapacity. Description of the App Service plan scale options.

Optional default

default: undefined | number

member: {number} [default] Default number of workers for this App Service plan SKU.

Optional maximum

maximum: undefined | number

member: {number} [maximum] Maximum number of workers for this App Service plan SKU.

Optional minimum

minimum: undefined | number

member: {number} [minimum] Minimum number of workers for this App Service plan SKU.

Optional scaleType

scaleType: undefined | string

member: {string} [scaleType] Available scale configurations for an App Service plan.

serializedName

serializedName: string = "SkuCapacity"

type

type: object

className

className: string = "SkuCapacity"

name

modelProperties

name

Const SkuDescription

SkuDescription: object

interface: An interface representing SkuDescription. Description of a SKU for a scalable resource.

Optional capabilities

capabilities: Capability[]

member: {Capability[]} [capabilities] Capabilities of the SKU, e.g., is traffic manager enabled?

Optional capacity

capacity: undefined | number

member: {number} [capacity] Current number of instances assigned to the resource.

Optional family

family: undefined | string

member: {string} [family] Family code of the resource SKU.

Optional locations

locations: string[]

member: {string[]} [locations] Locations of the SKU.

Optional name

member: {string} [name] Name of the resource SKU.

serializedName

serializedName: string = "SkuDescription"

Optional size

size: undefined | string

member: {string} [size] Size specifier of the resource SKU.

Optional skuCapacity

skuCapacity: SkuCapacity

member: {SkuCapacity} [skuCapacity] Min, max, and default scale values of the SKU.

Optional tier

tier: undefined | string

member: {string} [tier] Service tier of the resource SKU.

type

type: object

className

className: string = "SkuDescription"

name

modelProperties

name

size: object

serializedName

serializedName: string = "size"

type

type: object

name

skuCapacity

skuCapacity: object

serializedName

serializedName: string = "skuCapacity"

type

type: object

className

className: string = "SkuCapacity"

name

tier

tier: object

serializedName

serializedName: string = "tier"

type

type: object

name

Const SkuInfo

SkuInfo: object

interface: An interface representing SkuInfo. SKU discovery information.

Optional capacity

capacity: SkuCapacity

member: {SkuCapacity} [capacity] Min, max, and default scale values of the SKU.

Optional resourceType

resourceType: undefined | string

member: {string} [resourceType] Resource type that this SKU applies to.

serializedName

serializedName: string = "SkuInfo"

Optional sku

sku: SkuDescription

member: {SkuDescription} [sku] Name and tier of the SKU.

type

type: object

className

className: string = "SkuInfo"

name

modelProperties

modelProperties: object

capacity

className

className: string = "SkuDescription"

name

Const SkuInfoCollection

SkuInfoCollection: object

interface: An interface representing the SkuInfoCollection. Collection of SKU information.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SkuInfoCollection"

__@iterator

__@iterator(): IterableIterator<SkuInfo>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<SkuInfo>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<SkuInfo>[]): SkuInfo[]
concat(...items: (T | ConcatArray<T>)[]): SkuInfo[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<SkuInfo>[]
 
 Additional items to add to the end of array1.
Returns SkuInfo[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns SkuInfo[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, SkuInfo]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, SkuInfo]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: SkuInfo, index: number, array: SkuInfo[]): boolean
    - Parameters
      - value: SkuInfo
      - index: number
      - array: SkuInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: SkuInfo, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: SkuInfo
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): SkuInfo[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: SkuInfo
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SkuInfo, index: number, array: SkuInfo[]): boolean
    - Parameters
      - value: SkuInfo
      - index: number
      - array: SkuInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SkuInfo, index: number, array: SkuInfo[]): any
    - Parameters
      - value: SkuInfo
      - index: number
      - array: SkuInfo[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns SkuInfo[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): SkuInfo | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: SkuInfo
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: SkuInfo, index: number, obj: SkuInfo[]): boolean
    - Parameters
      - this: void
      - value: SkuInfo
      - index: number
      - obj: SkuInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: SkuInfo, index: number, obj: SkuInfo[]): boolean
    - Parameters
      - value: SkuInfo
      - index: number
      - obj: SkuInfo[]
      Returns boolean
- Optional thisArg: any
Returns SkuInfo | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: SkuInfo, index: number, obj: SkuInfo[]): boolean
    - Parameters
      - value: SkuInfo
      - index: number
      - obj: SkuInfo[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: SkuInfo, index: number, array: SkuInfo[]): void
    - Parameters
      - value: SkuInfo
      - index: number
      - array: SkuInfo[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: SkuInfo, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: SkuInfo
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: SkuInfo, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: SkuInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: SkuInfo, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: SkuInfo
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: SkuInfo, index: number, array: SkuInfo[]): U
    - Parameters
      - value: SkuInfo
      - index: number
      - array: SkuInfo[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): SkuInfo | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns SkuInfo | undefined

push

push(...items: SkuInfo[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: SkuInfo[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): SkuInfo
reduce(callbackfn: function, initialValue: SkuInfo): SkuInfo
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SkuInfo, currentValue: SkuInfo, currentIndex: number, array: SkuInfo[]): SkuInfo
    - Parameters
      - previousValue: SkuInfo
      - currentValue: SkuInfo
      - currentIndex: number
      - array: SkuInfo[]
      Returns SkuInfo
Returns SkuInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: SkuInfo, currentValue: SkuInfo, currentIndex: number, array: SkuInfo[]): SkuInfo
    - Parameters
      - previousValue: SkuInfo
      - currentValue: SkuInfo
      - currentIndex: number
      - array: SkuInfo[]
      Returns SkuInfo
- initialValue: SkuInfo
Returns SkuInfo
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SkuInfo, currentIndex: number, array: SkuInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: SkuInfo
      - currentIndex: number
      - array: SkuInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): SkuInfo
reduceRight(callbackfn: function, initialValue: SkuInfo): SkuInfo
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SkuInfo, currentValue: SkuInfo, currentIndex: number, array: SkuInfo[]): SkuInfo
    - Parameters
      - previousValue: SkuInfo
      - currentValue: SkuInfo
      - currentIndex: number
      - array: SkuInfo[]
      Returns SkuInfo
Returns SkuInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: SkuInfo, currentValue: SkuInfo, currentIndex: number, array: SkuInfo[]): SkuInfo
    - Parameters
      - previousValue: SkuInfo
      - currentValue: SkuInfo
      - currentIndex: number
      - array: SkuInfo[]
      Returns SkuInfo
- initialValue: SkuInfo
Returns SkuInfo
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SkuInfo, currentIndex: number, array: SkuInfo[]): U
    - Parameters
      - previousValue: U
      - currentValue: SkuInfo
      - currentIndex: number
      - array: SkuInfo[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): SkuInfo[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns SkuInfo[]

shift

shift(): SkuInfo | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns SkuInfo | undefined

slice

slice(start?: undefined | number, end?: undefined | number): SkuInfo[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns SkuInfo[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: SkuInfo, index: number, array: SkuInfo[]): boolean
    - Parameters
      - value: SkuInfo
      - index: number
      - array: SkuInfo[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): SkuInfo[]
splice(start: number, deleteCount: number, ...items: SkuInfo[]): SkuInfo[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns SkuInfo[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: SkuInfo[]
  
  Elements to insert into the array in place of the deleted elements.
Returns SkuInfo[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: SkuInfo[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: SkuInfo[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<SkuInfo>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<SkuInfo>

type

type: object

className

className: string = "SkuInfoCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "SkuInfo"

name

Const SkuInfos

SkuInfos: object

interface: An interface representing SkuInfos. Collection of SKU information.

Optional resourceType

resourceType: undefined | string

member: {string} [resourceType] Resource type that this SKU applies to.

serializedName

serializedName: string = "SkuInfos"

Optional skus

skus: GlobalCsmSkuDescription[]

member: {GlobalCsmSkuDescription[]} [skus] List of SKUs the subscription is able to use.

type

type: object

className

className: string = "SkuInfos"

name

modelProperties

name

Const SlotConfigNamesResource

SlotConfigNamesResource: object

interface: An interface representing SlotConfigNamesResource. Slot Config names azure resource.
extends: ProxyOnlyResource

Optional appSettingNames

appSettingNames: string[]

member: {string[]} [appSettingNames] List of application settings names.

Optional azureStorageConfigNames

azureStorageConfigNames: string[]

member: {string[]} [azureStorageConfigNames] List of external Azure storage account identifiers.

Optional connectionStringNames

connectionStringNames: string[]

member: {string[]} [connectionStringNames] List of connection string names.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

element: object

type

type: object

name

connectionStringNames

connectionStringNames: object

serializedName

serializedName: string = "properties.connectionStringNames"

type

type: object

name

element

element: object

type

type: object

name

Const SlotDifference

SlotDifference: object

interface: An interface representing SlotDifference. A setting difference between two deployment slots of an app.
extends: ProxyOnlyResource

Optional description

description: undefined | string

member: {string} [description] Description of the setting difference. NOTE: This property will not be serialized. It can only be populated by the server.

Optional diffRule

diffRule: undefined | string

member: {string} [diffRule] Rule that describes how to process the setting difference during a slot swap. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional level

level: undefined | string

member: {string} [level] Level of the difference: Information, Warning or Error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SlotDifference"

Optional settingName

settingName: undefined | string

member: {string} [settingName] Name of the setting. NOTE: This property will not be serialized. It can only be populated by the server.

Optional settingType

settingType: undefined | string

member: {string} [settingType] The type of the setting: General, AppSetting or ConnectionString. NOTE: This property will not be serialized. It can only be populated by the server.

Optional valueInCurrentSlot

valueInCurrentSlot: undefined | string

member: {string} [valueInCurrentSlot] Value of the setting in the current slot. NOTE: This property will not be serialized. It can only be populated by the server.

Optional valueInTargetSlot

valueInTargetSlot: undefined | string

member: {string} [valueInTargetSlot] Value of the setting in the target slot. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SlotDifference"

name

modelProperties

name

Const SlotDifferenceCollection

SlotDifferenceCollection: object

interface: An interface representing the SlotDifferenceCollection. Collection of slot differences.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SlotDifferenceCollection"

__@iterator

__@iterator(): IterableIterator<SlotDifference>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<SlotDifference>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<SlotDifference>[]): SlotDifference[]
concat(...items: (T | ConcatArray<T>)[]): SlotDifference[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<SlotDifference>[]
 
 Additional items to add to the end of array1.
Returns SlotDifference[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns SlotDifference[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, SlotDifference]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, SlotDifference]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: SlotDifference, index: number, array: SlotDifference[]): boolean
    - Parameters
      - value: SlotDifference
      - index: number
      - array: SlotDifference[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: SlotDifference, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: SlotDifference
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): SlotDifference[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: SlotDifference
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SlotDifference, index: number, array: SlotDifference[]): boolean
    - Parameters
      - value: SlotDifference
      - index: number
      - array: SlotDifference[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SlotDifference, index: number, array: SlotDifference[]): any
    - Parameters
      - value: SlotDifference
      - index: number
      - array: SlotDifference[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns SlotDifference[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): SlotDifference | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: SlotDifference
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: SlotDifference, index: number, obj: SlotDifference[]): boolean
    - Parameters
      - this: void
      - value: SlotDifference
      - index: number
      - obj: SlotDifference[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: SlotDifference, index: number, obj: SlotDifference[]): boolean
    - Parameters
      - value: SlotDifference
      - index: number
      - obj: SlotDifference[]
      Returns boolean
- Optional thisArg: any
Returns SlotDifference | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: SlotDifference, index: number, obj: SlotDifference[]): boolean
    - Parameters
      - value: SlotDifference
      - index: number
      - obj: SlotDifference[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: SlotDifference, index: number, array: SlotDifference[]): void
    - Parameters
      - value: SlotDifference
      - index: number
      - array: SlotDifference[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: SlotDifference, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: SlotDifference
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: SlotDifference, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: SlotDifference
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: SlotDifference, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: SlotDifference
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: SlotDifference, index: number, array: SlotDifference[]): U
    - Parameters
      - value: SlotDifference
      - index: number
      - array: SlotDifference[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): SlotDifference | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns SlotDifference | undefined

push

push(...items: SlotDifference[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: SlotDifference[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): SlotDifference
reduce(callbackfn: function, initialValue: SlotDifference): SlotDifference
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SlotDifference, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): SlotDifference
    - Parameters
      - previousValue: SlotDifference
      - currentValue: SlotDifference
      - currentIndex: number
      - array: SlotDifference[]
      Returns SlotDifference
Returns SlotDifference
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: SlotDifference, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): SlotDifference
    - Parameters
      - previousValue: SlotDifference
      - currentValue: SlotDifference
      - currentIndex: number
      - array: SlotDifference[]
      Returns SlotDifference
- initialValue: SlotDifference
Returns SlotDifference
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): U
    - Parameters
      - previousValue: U
      - currentValue: SlotDifference
      - currentIndex: number
      - array: SlotDifference[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): SlotDifference
reduceRight(callbackfn: function, initialValue: SlotDifference): SlotDifference
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SlotDifference, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): SlotDifference
    - Parameters
      - previousValue: SlotDifference
      - currentValue: SlotDifference
      - currentIndex: number
      - array: SlotDifference[]
      Returns SlotDifference
Returns SlotDifference
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: SlotDifference, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): SlotDifference
    - Parameters
      - previousValue: SlotDifference
      - currentValue: SlotDifference
      - currentIndex: number
      - array: SlotDifference[]
      Returns SlotDifference
- initialValue: SlotDifference
Returns SlotDifference
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SlotDifference, currentIndex: number, array: SlotDifference[]): U
    - Parameters
      - previousValue: U
      - currentValue: SlotDifference
      - currentIndex: number
      - array: SlotDifference[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): SlotDifference[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns SlotDifference[]

shift

shift(): SlotDifference | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns SlotDifference | undefined

slice

slice(start?: undefined | number, end?: undefined | number): SlotDifference[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns SlotDifference[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: SlotDifference, index: number, array: SlotDifference[]): boolean
    - Parameters
      - value: SlotDifference
      - index: number
      - array: SlotDifference[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): SlotDifference[]
splice(start: number, deleteCount: number, ...items: SlotDifference[]): SlotDifference[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns SlotDifference[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: SlotDifference[]
  
  Elements to insert into the array in place of the deleted elements.
Returns SlotDifference[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: SlotDifference[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: SlotDifference[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<SlotDifference>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<SlotDifference>

type

type: object

className

className: string = "SlotDifferenceCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "SlotDifference"

name

Const SlotSwapStatus

SlotSwapStatus: object

interface: An interface representing SlotSwapStatus. The status of the last successfull slot swap operation.

Optional destinationSlotName

destinationSlotName: undefined | string

member: {string} [destinationSlotName] The destination slot of the last swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SlotSwapStatus"

Optional sourceSlotName

sourceSlotName: undefined | string

member: {string} [sourceSlotName] The source slot of the last swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional timestampUtc

timestampUtc: Date

member: {Date} [timestampUtc] The time the last successful slot swap completed. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "SlotSwapStatus"

name

modelProperties

name

Const SlowRequestsBasedTrigger

SlowRequestsBasedTrigger: object

interface: An interface representing SlowRequestsBasedTrigger. Trigger based on request execution time.

Optional count

member: {number} [count] Request Count.

serializedName

serializedName: string = "SlowRequestsBasedTrigger"

Optional timeInterval

timeInterval: undefined | string

member: {string} [timeInterval] Time interval.

Optional timeTaken

timeTaken: undefined | string

member: {string} [timeTaken] Time taken.

type

type: object

className

className: string = "SlowRequestsBasedTrigger"

name

modelProperties

modelProperties: object

Snapshot: object

interface: An interface representing Snapshot. A snapshot of an app.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Snapshot"

Optional time

time: undefined | string

member: {string} [time] The time the snapshot was taken. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "Snapshot"

name

modelProperties

modelProperties: object

time

time: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.time"

type

type: object

name

Const SnapshotCollection

SnapshotCollection: object

interface: An interface representing the SnapshotCollection. Collection of snapshots which can be used to revert an app to a previous time.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SnapshotCollection"

__@iterator

__@iterator(): IterableIterator<Snapshot>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<Snapshot>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<Snapshot>[]): Snapshot[]
concat(...items: (T | ConcatArray<T>)[]): Snapshot[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<Snapshot>[]
 
 Additional items to add to the end of array1.
Returns Snapshot[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns Snapshot[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, Snapshot]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, Snapshot]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: Snapshot, index: number, array: Snapshot[]): boolean
    - Parameters
      - value: Snapshot
      - index: number
      - array: Snapshot[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: Snapshot, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: Snapshot
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): Snapshot[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: Snapshot
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Snapshot, index: number, array: Snapshot[]): boolean
    - Parameters
      - value: Snapshot
      - index: number
      - array: Snapshot[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Snapshot, index: number, array: Snapshot[]): any
    - Parameters
      - value: Snapshot
      - index: number
      - array: Snapshot[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Snapshot[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): Snapshot | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: Snapshot
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: Snapshot, index: number, obj: Snapshot[]): boolean
    - Parameters
      - this: void
      - value: Snapshot
      - index: number
      - obj: Snapshot[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: Snapshot, index: number, obj: Snapshot[]): boolean
    - Parameters
      - value: Snapshot
      - index: number
      - obj: Snapshot[]
      Returns boolean
- Optional thisArg: any
Returns Snapshot | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: Snapshot, index: number, obj: Snapshot[]): boolean
    - Parameters
      - value: Snapshot
      - index: number
      - obj: Snapshot[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: Snapshot, index: number, array: Snapshot[]): void
    - Parameters
      - value: Snapshot
      - index: number
      - array: Snapshot[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: Snapshot, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: Snapshot
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: Snapshot, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: Snapshot
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: Snapshot, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: Snapshot
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: Snapshot, index: number, array: Snapshot[]): U
    - Parameters
      - value: Snapshot
      - index: number
      - array: Snapshot[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): Snapshot | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns Snapshot | undefined

push

push(...items: Snapshot[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: Snapshot[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): Snapshot
reduce(callbackfn: function, initialValue: Snapshot): Snapshot
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Snapshot, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): Snapshot
    - Parameters
      - previousValue: Snapshot
      - currentValue: Snapshot
      - currentIndex: number
      - array: Snapshot[]
      Returns Snapshot
Returns Snapshot
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: Snapshot, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): Snapshot
    - Parameters
      - previousValue: Snapshot
      - currentValue: Snapshot
      - currentIndex: number
      - array: Snapshot[]
      Returns Snapshot
- initialValue: Snapshot
Returns Snapshot
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): U
    - Parameters
      - previousValue: U
      - currentValue: Snapshot
      - currentIndex: number
      - array: Snapshot[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): Snapshot
reduceRight(callbackfn: function, initialValue: Snapshot): Snapshot
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Snapshot, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): Snapshot
    - Parameters
      - previousValue: Snapshot
      - currentValue: Snapshot
      - currentIndex: number
      - array: Snapshot[]
      Returns Snapshot
Returns Snapshot
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: Snapshot, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): Snapshot
    - Parameters
      - previousValue: Snapshot
      - currentValue: Snapshot
      - currentIndex: number
      - array: Snapshot[]
      Returns Snapshot
- initialValue: Snapshot
Returns Snapshot
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Snapshot, currentIndex: number, array: Snapshot[]): U
    - Parameters
      - previousValue: U
      - currentValue: Snapshot
      - currentIndex: number
      - array: Snapshot[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): Snapshot[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns Snapshot[]

shift

shift(): Snapshot | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns Snapshot | undefined

slice

slice(start?: undefined | number, end?: undefined | number): Snapshot[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns Snapshot[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: Snapshot, index: number, array: Snapshot[]): boolean
    - Parameters
      - value: Snapshot
      - index: number
      - array: Snapshot[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): Snapshot[]
splice(start: number, deleteCount: number, ...items: Snapshot[]): Snapshot[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns Snapshot[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: Snapshot[]
  
  Elements to insert into the array in place of the deleted elements.
Returns Snapshot[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: Snapshot[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: Snapshot[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<Snapshot>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<Snapshot>

type

type: object

className

className: string = "SnapshotCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "Snapshot"

name

Const SnapshotRecoverySource

SnapshotRecoverySource: object

interface: An interface representing SnapshotRecoverySource. Specifies the web app that snapshot contents will be retrieved from.

Optional id

id: undefined | string

member: {string} [id] ARM resource ID of the source app. /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.

Optional location

location: undefined | string

member: {string} [location] Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS

serializedName

serializedName: string = "SnapshotRecoverySource"

type

type: object

className

className: string = "SnapshotRecoverySource"

name

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

Const SnapshotRestoreRequest

SnapshotRestoreRequest: object

interface: An interface representing SnapshotRestoreRequest. Details about app recovery operation.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ignoreConflictingHostNames

ignoreConflictingHostNames: undefined | false | true

member: {boolean} [ignoreConflictingHostNames] If true, custom hostname conflicts will be ignored when recovering to a target web app. This setting is only necessary when RecoverConfiguration is enabled.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

overwrite

overwrite: boolean

member: {boolean} overwrite If true the restore operation can overwrite source app; otherwise, false.

Optional recoverConfiguration

recoverConfiguration: undefined | false | true

member: {boolean} [recoverConfiguration] If true, site configuration, in addition to content, will be reverted.

Optional recoverySource

recoverySource: SnapshotRecoverySource

member: {SnapshotRecoverySource} [recoverySource] Optional. Specifies the web app that snapshot contents will be retrieved from. If empty, the targeted web app will be used as the source.

serializedName

serializedName: string = "SnapshotRestoreRequest"

Optional snapshotTime

snapshotTime: undefined | string

member: {string} [snapshotTime] Point in time in which the app restore should be done, formatted as a DateTime string.

Optional useDRSecondary

useDRSecondary: undefined | false | true

member: {boolean} [useDRSecondary] If true, the snapshot is retrieved from DRSecondary endpoint.

type

type: object

className

className: string = "SnapshotRestoreRequest"

name

modelProperties

modelProperties: object

ignoreConflictingHostNames

ignoreConflictingHostNames: object

serializedName

serializedName: string = "properties.ignoreConflictingHostNames"

type

type: object

name

overwrite

className

className: string = "SnapshotRecoverySource"

name

snapshotTime

snapshotTime: object

serializedName

serializedName: string = "properties.snapshotTime"

type

type: object

name

useDRSecondary

useDRSecondary: object

serializedName

serializedName: string = "properties.useDRSecondary"

type

type: object

name

Const Solution

Solution: object

interface: An interface representing Solution. Class Representing Solution for problems detected.

Optional data

data: NameValuePair[][]

member: {NameValuePair[][]} [data] Solution Data.

Optional description

description: undefined | string

member: {string} [description] Description of the solution

Optional displayName

displayName: undefined | string

member: {string} [displayName] Display Name of the solution

Optional id

id: undefined | number

member: {number} [id] Solution Id.

Optional metadata

metadata: NameValuePair[][]

member: {NameValuePair[][]} [metadata] Solution Metadata.

Optional order

order: undefined | number

member: {number} [order] Order of the solution.

serializedName

serializedName: string = "Solution"

type

type: object

member: {SolutionType} [type] Type of Solution. Possible values include: 'QuickSolution', 'DeepInvestigation', 'BestPractices'

className

className: string = "Solution"

name

modelProperties

modelProperties: object

data

data: object

serializedName

serializedName: string = "data"

type

type: object

serializedName: string = "type"

type

type: object

allowedValues

allowedValues: string[] = ["QuickSolution","DeepInvestigation","BestPractices"]

name

Const SourceControl

SourceControl: object

interface: An interface representing SourceControl. The source control OAuth token.
extends: ProxyOnlyResource

Optional expirationTime

expirationTime: Date

member: {Date} [expirationTime] OAuth token expiration.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional refreshToken

refreshToken: undefined | string

member: {string} [refreshToken] OAuth refresh token.

serializedName

serializedName: string = "SourceControl"

Optional token

token: undefined | string

member: {string} [token] OAuth access token.

Optional tokenSecret

tokenSecret: undefined | string

member: {string} [tokenSecret] OAuth access token secret.

type

type: object

className

className: string = "SourceControl"

name

modelProperties

name

Const SourceControlCollection

SourceControlCollection: object

interface: An interface representing the SourceControlCollection. Collection of source controls.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SourceControlCollection"

__@iterator

__@iterator(): IterableIterator<SourceControl>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<SourceControl>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<SourceControl>[]): SourceControl[]
concat(...items: (T | ConcatArray<T>)[]): SourceControl[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<SourceControl>[]
 
 Additional items to add to the end of array1.
Returns SourceControl[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns SourceControl[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, SourceControl]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, SourceControl]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: SourceControl, index: number, array: SourceControl[]): boolean
    - Parameters
      - value: SourceControl
      - index: number
      - array: SourceControl[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: SourceControl, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: SourceControl
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): SourceControl[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: SourceControl
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SourceControl, index: number, array: SourceControl[]): boolean
    - Parameters
      - value: SourceControl
      - index: number
      - array: SourceControl[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SourceControl, index: number, array: SourceControl[]): any
    - Parameters
      - value: SourceControl
      - index: number
      - array: SourceControl[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns SourceControl[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): SourceControl | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: SourceControl
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: SourceControl, index: number, obj: SourceControl[]): boolean
    - Parameters
      - this: void
      - value: SourceControl
      - index: number
      - obj: SourceControl[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: SourceControl, index: number, obj: SourceControl[]): boolean
    - Parameters
      - value: SourceControl
      - index: number
      - obj: SourceControl[]
      Returns boolean
- Optional thisArg: any
Returns SourceControl | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: SourceControl, index: number, obj: SourceControl[]): boolean
    - Parameters
      - value: SourceControl
      - index: number
      - obj: SourceControl[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: SourceControl, index: number, array: SourceControl[]): void
    - Parameters
      - value: SourceControl
      - index: number
      - array: SourceControl[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: SourceControl, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: SourceControl
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: SourceControl, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: SourceControl
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: SourceControl, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: SourceControl
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: SourceControl, index: number, array: SourceControl[]): U
    - Parameters
      - value: SourceControl
      - index: number
      - array: SourceControl[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): SourceControl | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns SourceControl | undefined

push

push(...items: SourceControl[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: SourceControl[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): SourceControl
reduce(callbackfn: function, initialValue: SourceControl): SourceControl
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SourceControl, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): SourceControl
    - Parameters
      - previousValue: SourceControl
      - currentValue: SourceControl
      - currentIndex: number
      - array: SourceControl[]
      Returns SourceControl
Returns SourceControl
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: SourceControl, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): SourceControl
    - Parameters
      - previousValue: SourceControl
      - currentValue: SourceControl
      - currentIndex: number
      - array: SourceControl[]
      Returns SourceControl
- initialValue: SourceControl
Returns SourceControl
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): U
    - Parameters
      - previousValue: U
      - currentValue: SourceControl
      - currentIndex: number
      - array: SourceControl[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): SourceControl
reduceRight(callbackfn: function, initialValue: SourceControl): SourceControl
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SourceControl, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): SourceControl
    - Parameters
      - previousValue: SourceControl
      - currentValue: SourceControl
      - currentIndex: number
      - array: SourceControl[]
      Returns SourceControl
Returns SourceControl
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: SourceControl, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): SourceControl
    - Parameters
      - previousValue: SourceControl
      - currentValue: SourceControl
      - currentIndex: number
      - array: SourceControl[]
      Returns SourceControl
- initialValue: SourceControl
Returns SourceControl
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SourceControl, currentIndex: number, array: SourceControl[]): U
    - Parameters
      - previousValue: U
      - currentValue: SourceControl
      - currentIndex: number
      - array: SourceControl[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): SourceControl[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns SourceControl[]

shift

shift(): SourceControl | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns SourceControl | undefined

slice

slice(start?: undefined | number, end?: undefined | number): SourceControl[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns SourceControl[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: SourceControl, index: number, array: SourceControl[]): boolean
    - Parameters
      - value: SourceControl
      - index: number
      - array: SourceControl[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): SourceControl[]
splice(start: number, deleteCount: number, ...items: SourceControl[]): SourceControl[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns SourceControl[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: SourceControl[]
  
  Elements to insert into the array in place of the deleted elements.
Returns SourceControl[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: SourceControl[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: SourceControl[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<SourceControl>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<SourceControl>

type

type: object

className

className: string = "SourceControlCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "SourceControl"

name

Const StackMajorVersion

StackMajorVersion: object

interface: An interface representing StackMajorVersion. Application stack major version.

Optional displayVersion

displayVersion: undefined | string

member: {string} [displayVersion] Application stack major version (display only).

Optional isDefault

isDefault: undefined | false | true

member: {boolean} [isDefault] true if this is the default major version; otherwise, false.

Optional minorVersions

minorVersions: StackMinorVersion[]

member: {StackMinorVersion[]} [minorVersions] Minor versions associated with the major version.

Optional runtimeVersion

runtimeVersion: undefined | string

member: {string} [runtimeVersion] Application stack major version (runtime only).

serializedName

serializedName: string = "StackMajorVersion"

type

type: object

className

className: string = "StackMajorVersion"

name

modelProperties

name

Const StackMinorVersion

StackMinorVersion: object

interface: An interface representing StackMinorVersion. Application stack minor version.

Optional displayVersion

displayVersion: undefined | string

member: {string} [displayVersion] Application stack minor version (display only).

Optional isDefault

isDefault: undefined | false | true

member: {boolean} [isDefault] true if this is the default minor version; otherwise, false.

Optional runtimeVersion

runtimeVersion: undefined | string

member: {string} [runtimeVersion] Application stack minor version (runtime only).

serializedName

serializedName: string = "StackMinorVersion"

type

type: object

className

className: string = "StackMinorVersion"

name

modelProperties

name

Const StampCapacity

StampCapacity: object

interface: An interface representing StampCapacity. Stamp capacity information.

Optional availableCapacity

availableCapacity: undefined | number

member: {number} [availableCapacity] Available capacity (# of machines, bytes of storage etc...).

Optional computeMode

computeMode: ComputeModeOptions

member: {ComputeModeOptions} [computeMode] Shared/dedicated workers. Possible values include: 'Shared', 'Dedicated', 'Dynamic'

Optional excludeFromCapacityAllocation

excludeFromCapacityAllocation: undefined | false | true

member: {boolean} [excludeFromCapacityAllocation] If true, it includes basic apps. Basic apps are not used for capacity allocation.

Optional isApplicableForAllComputeModes

isApplicableForAllComputeModes: undefined | false | true

member: {boolean} [isApplicableForAllComputeModes] true if capacity is applicable for all apps; otherwise, false.

Optional isLinux

isLinux: undefined | false | true

member: {boolean} [isLinux] Is this a linux stamp capacity

Optional name

member: {string} [name] Name of the stamp.

serializedName

serializedName: string = "StampCapacity"

Optional siteMode

siteMode: undefined | string

member: {string} [siteMode] Shared or Dedicated.

Optional totalCapacity

totalCapacity: undefined | number

member: {number} [totalCapacity] Total capacity (# of machines, bytes of storage etc...).

Optional unit

unit: undefined | string

member: {string} [unit] Name of the unit.

Optional workerSize

workerSize: WorkerSizeOptions

member: {WorkerSizeOptions} [workerSize] Size of the machines. Possible values include: 'Small', 'Medium', 'Large', 'D1', 'D2', 'D3', 'Default'

Optional workerSizeId

workerSizeId: undefined | number

member: {number} [workerSizeId] Size ID of machines: 0 - Small 1 - Medium 2 - Large

type

type: object

className

className: string = "StampCapacity"

name

modelProperties

modelProperties: object

availableCapacity

availableCapacity: object

serializedName

serializedName: string = "availableCapacity"

type

type: object

name

computeMode

type: object

name

Const StampCapacityCollection

StampCapacityCollection: object

interface: An interface representing the StampCapacityCollection. Collection of stamp capacities.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "StampCapacityCollection"

__@iterator

__@iterator(): IterableIterator<StampCapacity>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<StampCapacity>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<StampCapacity>[]): StampCapacity[]
concat(...items: (T | ConcatArray<T>)[]): StampCapacity[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<StampCapacity>[]
 
 Additional items to add to the end of array1.
Returns StampCapacity[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns StampCapacity[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, StampCapacity]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, StampCapacity]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: StampCapacity, index: number, array: StampCapacity[]): boolean
    - Parameters
      - value: StampCapacity
      - index: number
      - array: StampCapacity[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: StampCapacity, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: StampCapacity
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): StampCapacity[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: StampCapacity
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: StampCapacity, index: number, array: StampCapacity[]): boolean
    - Parameters
      - value: StampCapacity
      - index: number
      - array: StampCapacity[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: StampCapacity, index: number, array: StampCapacity[]): any
    - Parameters
      - value: StampCapacity
      - index: number
      - array: StampCapacity[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns StampCapacity[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): StampCapacity | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: StampCapacity
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: StampCapacity, index: number, obj: StampCapacity[]): boolean
    - Parameters
      - this: void
      - value: StampCapacity
      - index: number
      - obj: StampCapacity[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: StampCapacity, index: number, obj: StampCapacity[]): boolean
    - Parameters
      - value: StampCapacity
      - index: number
      - obj: StampCapacity[]
      Returns boolean
- Optional thisArg: any
Returns StampCapacity | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: StampCapacity, index: number, obj: StampCapacity[]): boolean
    - Parameters
      - value: StampCapacity
      - index: number
      - obj: StampCapacity[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: StampCapacity, index: number, array: StampCapacity[]): void
    - Parameters
      - value: StampCapacity
      - index: number
      - array: StampCapacity[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: StampCapacity, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: StampCapacity
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: StampCapacity, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: StampCapacity
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: StampCapacity, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: StampCapacity
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: StampCapacity, index: number, array: StampCapacity[]): U
    - Parameters
      - value: StampCapacity
      - index: number
      - array: StampCapacity[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): StampCapacity | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns StampCapacity | undefined

push

push(...items: StampCapacity[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: StampCapacity[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): StampCapacity
reduce(callbackfn: function, initialValue: StampCapacity): StampCapacity
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: StampCapacity, currentValue: StampCapacity, currentIndex: number, array: StampCapacity[]): StampCapacity
    - Parameters
      - previousValue: StampCapacity
      - currentValue: StampCapacity
      - currentIndex: number
      - array: StampCapacity[]
      Returns StampCapacity
Returns StampCapacity
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: StampCapacity, currentValue: StampCapacity, currentIndex: number, array: StampCapacity[]): StampCapacity
    - Parameters
      - previousValue: StampCapacity
      - currentValue: StampCapacity
      - currentIndex: number
      - array: StampCapacity[]
      Returns StampCapacity
- initialValue: StampCapacity
Returns StampCapacity
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: StampCapacity, currentIndex: number, array: StampCapacity[]): U
    - Parameters
      - previousValue: U
      - currentValue: StampCapacity
      - currentIndex: number
      - array: StampCapacity[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): StampCapacity
reduceRight(callbackfn: function, initialValue: StampCapacity): StampCapacity
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: StampCapacity, currentValue: StampCapacity, currentIndex: number, array: StampCapacity[]): StampCapacity
    - Parameters
      - previousValue: StampCapacity
      - currentValue: StampCapacity
      - currentIndex: number
      - array: StampCapacity[]
      Returns StampCapacity
Returns StampCapacity
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: StampCapacity, currentValue: StampCapacity, currentIndex: number, array: StampCapacity[]): StampCapacity
    - Parameters
      - previousValue: StampCapacity
      - currentValue: StampCapacity
      - currentIndex: number
      - array: StampCapacity[]
      Returns StampCapacity
- initialValue: StampCapacity
Returns StampCapacity
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: StampCapacity, currentIndex: number, array: StampCapacity[]): U
    - Parameters
      - previousValue: U
      - currentValue: StampCapacity
      - currentIndex: number
      - array: StampCapacity[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): StampCapacity[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns StampCapacity[]

shift

shift(): StampCapacity | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns StampCapacity | undefined

slice

slice(start?: undefined | number, end?: undefined | number): StampCapacity[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns StampCapacity[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: StampCapacity, index: number, array: StampCapacity[]): boolean
    - Parameters
      - value: StampCapacity
      - index: number
      - array: StampCapacity[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): StampCapacity[]
splice(start: number, deleteCount: number, ...items: StampCapacity[]): StampCapacity[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns StampCapacity[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: StampCapacity[]
  
  Elements to insert into the array in place of the deleted elements.
Returns StampCapacity[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: StampCapacity[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: StampCapacity[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<StampCapacity>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<StampCapacity>

type

type: object

className

className: string = "StampCapacityCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "StampCapacity"

name

Const StatusCodesBasedTrigger

StatusCodesBasedTrigger: object

interface: An interface representing StatusCodesBasedTrigger. Trigger based on status code.

Optional count

member: {number} [count] Request Count.

serializedName

serializedName: string = "StatusCodesBasedTrigger"

Optional status

status: undefined | number

member: {number} [status] HTTP status code.

Optional subStatus

subStatus: undefined | number

member: {number} [subStatus] Request Sub Status.

Optional timeInterval

timeInterval: undefined | string

member: {string} [timeInterval] Time interval.

Optional win32Status

win32Status: undefined | number

member: {number} [win32Status] Win32 error code.

type

type: object

className

className: string = "StatusCodesBasedTrigger"

name

modelProperties

modelProperties: object

StorageMigrationOptions: object

interface: An interface representing StorageMigrationOptions. Options for app content migration.
extends: ProxyOnlyResource

azurefilesConnectionString

azurefilesConnectionString: string

member: {string} azurefilesConnectionString AzureFiles connection string.

azurefilesShare

azurefilesShare: string

member: {string} azurefilesShare AzureFiles share.

Optional blockWriteAccessToSite

blockWriteAccessToSite: undefined | false | true

member: {boolean} [blockWriteAccessToSite] true if the app should be read only during copy operation; otherwise, false. Default value: false .

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "StorageMigrationOptions"

Optional switchSiteAfterMigration

switchSiteAfterMigration: undefined | false | true

member: {boolean} [switchSiteAfterMigration] trueif the app should be switched over; otherwise, false. Default value: false .

type

type: object

className

className: string = "StorageMigrationOptions"

name

modelProperties

name

Const StorageMigrationResponse

StorageMigrationResponse: object

interface: An interface representing StorageMigrationResponse. Response for a migration of app content request.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional operationId

operationId: undefined | string

member: {string} [operationId] When server starts the migration process, it will return an operation ID identifying that particular migration operation. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "StorageMigrationResponse"

type

type: object

className

className: string = "StorageMigrationResponse"

name

modelProperties

modelProperties: object

operationId

operationId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.operationId"

type

type: object

name

Const StringDictionary

StringDictionary: object

interface: An interface representing StringDictionary. String dictionary resource.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: undefined | object

member: {{ [propertyName: string]: string }} [properties] Settings.

serializedName

SwiftVirtualNetwork: object

interface: An interface representing SwiftVirtualNetwork. Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SwiftVirtualNetwork"

Optional subnetResourceId

subnetResourceId: undefined | string

member: {string} [subnetResourceId] The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.

Optional swiftSupported

swiftSupported: undefined | false | true

member: {boolean} [swiftSupported] A flag that specifies if the scale unit this Web App is on supports Swift integration.

type

type: object

className

className: string = "SwiftVirtualNetwork"

name

modelProperties

modelProperties: object

subnetResourceId

subnetResourceId: object

serializedName

serializedName: string = "properties.subnetResourceId"

type

type: object

name

swiftSupported

swiftSupported: object

serializedName

serializedName: string = "properties.swiftSupported"

type

type: object

name

Const TldLegalAgreement

TldLegalAgreement: object

interface: An interface representing TldLegalAgreement. Legal agreement for a top level domain.

agreementKey

agreementKey: string

member: {string} agreementKey Unique identifier for the agreement.

content

content: string

member: {string} content Agreement details.

serializedName

serializedName: string = "TldLegalAgreement"

title

title: string

member: {string} title Agreement title.

Optional url

url: undefined | string

member: {string} [url] URL where a copy of the agreement details is hosted.

type

type: object

className

className: string = "TldLegalAgreement"

name

modelProperties

name

url

url: object

serializedName

serializedName: string = "url"

type

type: object

name

Const TldLegalAgreementCollection

TldLegalAgreementCollection: object

interface: An interface representing the TldLegalAgreementCollection. Collection of top-level domain legal agreements.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TldLegalAgreementCollection"

__@iterator

__@iterator(): IterableIterator<TldLegalAgreement>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<TldLegalAgreement>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<TldLegalAgreement>[]): TldLegalAgreement[]
concat(...items: (T | ConcatArray<T>)[]): TldLegalAgreement[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<TldLegalAgreement>[]
 
 Additional items to add to the end of array1.
Returns TldLegalAgreement[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns TldLegalAgreement[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, TldLegalAgreement]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, TldLegalAgreement]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: TldLegalAgreement, index: number, array: TldLegalAgreement[]): boolean
    - Parameters
      - value: TldLegalAgreement
      - index: number
      - array: TldLegalAgreement[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: TldLegalAgreement, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: TldLegalAgreement
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): TldLegalAgreement[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: TldLegalAgreement
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: TldLegalAgreement, index: number, array: TldLegalAgreement[]): boolean
    - Parameters
      - value: TldLegalAgreement
      - index: number
      - array: TldLegalAgreement[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: TldLegalAgreement, index: number, array: TldLegalAgreement[]): any
    - Parameters
      - value: TldLegalAgreement
      - index: number
      - array: TldLegalAgreement[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns TldLegalAgreement[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): TldLegalAgreement | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: TldLegalAgreement
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: TldLegalAgreement, index: number, obj: TldLegalAgreement[]): boolean
    - Parameters
      - this: void
      - value: TldLegalAgreement
      - index: number
      - obj: TldLegalAgreement[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: TldLegalAgreement, index: number, obj: TldLegalAgreement[]): boolean
    - Parameters
      - value: TldLegalAgreement
      - index: number
      - obj: TldLegalAgreement[]
      Returns boolean
- Optional thisArg: any
Returns TldLegalAgreement | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: TldLegalAgreement, index: number, obj: TldLegalAgreement[]): boolean
    - Parameters
      - value: TldLegalAgreement
      - index: number
      - obj: TldLegalAgreement[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: TldLegalAgreement, index: number, array: TldLegalAgreement[]): void
    - Parameters
      - value: TldLegalAgreement
      - index: number
      - array: TldLegalAgreement[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: TldLegalAgreement, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: TldLegalAgreement
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: TldLegalAgreement, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: TldLegalAgreement
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: TldLegalAgreement, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: TldLegalAgreement
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: TldLegalAgreement, index: number, array: TldLegalAgreement[]): U
    - Parameters
      - value: TldLegalAgreement
      - index: number
      - array: TldLegalAgreement[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): TldLegalAgreement | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns TldLegalAgreement | undefined

push

push(...items: TldLegalAgreement[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: TldLegalAgreement[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): TldLegalAgreement
reduce(callbackfn: function, initialValue: TldLegalAgreement): TldLegalAgreement
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: TldLegalAgreement, currentValue: TldLegalAgreement, currentIndex: number, array: TldLegalAgreement[]): TldLegalAgreement
    - Parameters
      - previousValue: TldLegalAgreement
      - currentValue: TldLegalAgreement
      - currentIndex: number
      - array: TldLegalAgreement[]
      Returns TldLegalAgreement
Returns TldLegalAgreement
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: TldLegalAgreement, currentValue: TldLegalAgreement, currentIndex: number, array: TldLegalAgreement[]): TldLegalAgreement
    - Parameters
      - previousValue: TldLegalAgreement
      - currentValue: TldLegalAgreement
      - currentIndex: number
      - array: TldLegalAgreement[]
      Returns TldLegalAgreement
- initialValue: TldLegalAgreement
Returns TldLegalAgreement
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: TldLegalAgreement, currentIndex: number, array: TldLegalAgreement[]): U
    - Parameters
      - previousValue: U
      - currentValue: TldLegalAgreement
      - currentIndex: number
      - array: TldLegalAgreement[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): TldLegalAgreement
reduceRight(callbackfn: function, initialValue: TldLegalAgreement): TldLegalAgreement
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: TldLegalAgreement, currentValue: TldLegalAgreement, currentIndex: number, array: TldLegalAgreement[]): TldLegalAgreement
    - Parameters
      - previousValue: TldLegalAgreement
      - currentValue: TldLegalAgreement
      - currentIndex: number
      - array: TldLegalAgreement[]
      Returns TldLegalAgreement
Returns TldLegalAgreement
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: TldLegalAgreement, currentValue: TldLegalAgreement, currentIndex: number, array: TldLegalAgreement[]): TldLegalAgreement
    - Parameters
      - previousValue: TldLegalAgreement
      - currentValue: TldLegalAgreement
      - currentIndex: number
      - array: TldLegalAgreement[]
      Returns TldLegalAgreement
- initialValue: TldLegalAgreement
Returns TldLegalAgreement
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: TldLegalAgreement, currentIndex: number, array: TldLegalAgreement[]): U
    - Parameters
      - previousValue: U
      - currentValue: TldLegalAgreement
      - currentIndex: number
      - array: TldLegalAgreement[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): TldLegalAgreement[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns TldLegalAgreement[]

shift

shift(): TldLegalAgreement | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns TldLegalAgreement | undefined

slice

slice(start?: undefined | number, end?: undefined | number): TldLegalAgreement[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns TldLegalAgreement[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: TldLegalAgreement, index: number, array: TldLegalAgreement[]): boolean
    - Parameters
      - value: TldLegalAgreement
      - index: number
      - array: TldLegalAgreement[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): TldLegalAgreement[]
splice(start: number, deleteCount: number, ...items: TldLegalAgreement[]): TldLegalAgreement[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns TldLegalAgreement[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: TldLegalAgreement[]
  
  Elements to insert into the array in place of the deleted elements.
Returns TldLegalAgreement[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: TldLegalAgreement[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: TldLegalAgreement[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<TldLegalAgreement>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<TldLegalAgreement>

type

type: object

className

className: string = "TldLegalAgreementCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "TldLegalAgreement"

name

Const TopLevelDomain

TopLevelDomain: object

interface: An interface representing TopLevelDomain. A top level domain object.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional privacy

privacy: undefined | false | true

member: {boolean} [privacy] If true, then the top level domain supports domain privacy; otherwise, false.

serializedName

serializedName: string = "TopLevelDomain"

type

type: object

className

className: string = "TopLevelDomain"

name

modelProperties

modelProperties: object

privacy

privacy: object

serializedName

serializedName: string = "properties.privacy"

type

type: object

name

Const TopLevelDomainAgreementOption

TopLevelDomainAgreementOption: object

interface: An interface representing TopLevelDomainAgreementOption. Options for retrieving the list of top level domain legal agreements.

Optional forTransfer

forTransfer: undefined | false | true

member: {boolean} [forTransfer] If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false.

Optional includePrivacy

includePrivacy: undefined | false | true

member: {boolean} [includePrivacy] If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false.

serializedName

serializedName: string = "TopLevelDomainAgreementOption"

type

type: object

className

className: string = "TopLevelDomainAgreementOption"

name

modelProperties

modelProperties: object

forTransfer

forTransfer: object

serializedName

serializedName: string = "forTransfer"

type

type: object

name

includePrivacy

includePrivacy: object

serializedName

serializedName: string = "includePrivacy"

type

type: object

name

Const TopLevelDomainCollection

TopLevelDomainCollection: object

interface: An interface representing the TopLevelDomainCollection. Collection of Top-level domains.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TopLevelDomainCollection"

__@iterator

__@iterator(): IterableIterator<TopLevelDomain>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<TopLevelDomain>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<TopLevelDomain>[]): TopLevelDomain[]
concat(...items: (T | ConcatArray<T>)[]): TopLevelDomain[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<TopLevelDomain>[]
 
 Additional items to add to the end of array1.
Returns TopLevelDomain[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns TopLevelDomain[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, TopLevelDomain]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, TopLevelDomain]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: TopLevelDomain, index: number, array: TopLevelDomain[]): boolean
    - Parameters
      - value: TopLevelDomain
      - index: number
      - array: TopLevelDomain[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: TopLevelDomain, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: TopLevelDomain
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): TopLevelDomain[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: TopLevelDomain
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: TopLevelDomain, index: number, array: TopLevelDomain[]): boolean
    - Parameters
      - value: TopLevelDomain
      - index: number
      - array: TopLevelDomain[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: TopLevelDomain, index: number, array: TopLevelDomain[]): any
    - Parameters
      - value: TopLevelDomain
      - index: number
      - array: TopLevelDomain[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns TopLevelDomain[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): TopLevelDomain | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: TopLevelDomain
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: TopLevelDomain, index: number, obj: TopLevelDomain[]): boolean
    - Parameters
      - this: void
      - value: TopLevelDomain
      - index: number
      - obj: TopLevelDomain[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: TopLevelDomain, index: number, obj: TopLevelDomain[]): boolean
    - Parameters
      - value: TopLevelDomain
      - index: number
      - obj: TopLevelDomain[]
      Returns boolean
- Optional thisArg: any
Returns TopLevelDomain | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: TopLevelDomain, index: number, obj: TopLevelDomain[]): boolean
    - Parameters
      - value: TopLevelDomain
      - index: number
      - obj: TopLevelDomain[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: TopLevelDomain, index: number, array: TopLevelDomain[]): void
    - Parameters
      - value: TopLevelDomain
      - index: number
      - array: TopLevelDomain[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: TopLevelDomain, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: TopLevelDomain
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: TopLevelDomain, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: TopLevelDomain
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: TopLevelDomain, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: TopLevelDomain
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: TopLevelDomain, index: number, array: TopLevelDomain[]): U
    - Parameters
      - value: TopLevelDomain
      - index: number
      - array: TopLevelDomain[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): TopLevelDomain | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns TopLevelDomain | undefined

push

push(...items: TopLevelDomain[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: TopLevelDomain[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): TopLevelDomain
reduce(callbackfn: function, initialValue: TopLevelDomain): TopLevelDomain
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: TopLevelDomain, currentValue: TopLevelDomain, currentIndex: number, array: TopLevelDomain[]): TopLevelDomain
    - Parameters
      - previousValue: TopLevelDomain
      - currentValue: TopLevelDomain
      - currentIndex: number
      - array: TopLevelDomain[]
      Returns TopLevelDomain
Returns TopLevelDomain
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: TopLevelDomain, currentValue: TopLevelDomain, currentIndex: number, array: TopLevelDomain[]): TopLevelDomain
    - Parameters
      - previousValue: TopLevelDomain
      - currentValue: TopLevelDomain
      - currentIndex: number
      - array: TopLevelDomain[]
      Returns TopLevelDomain
- initialValue: TopLevelDomain
Returns TopLevelDomain
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: TopLevelDomain, currentIndex: number, array: TopLevelDomain[]): U
    - Parameters
      - previousValue: U
      - currentValue: TopLevelDomain
      - currentIndex: number
      - array: TopLevelDomain[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): TopLevelDomain
reduceRight(callbackfn: function, initialValue: TopLevelDomain): TopLevelDomain
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: TopLevelDomain, currentValue: TopLevelDomain, currentIndex: number, array: TopLevelDomain[]): TopLevelDomain
    - Parameters
      - previousValue: TopLevelDomain
      - currentValue: TopLevelDomain
      - currentIndex: number
      - array: TopLevelDomain[]
      Returns TopLevelDomain
Returns TopLevelDomain
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: TopLevelDomain, currentValue: TopLevelDomain, currentIndex: number, array: TopLevelDomain[]): TopLevelDomain
    - Parameters
      - previousValue: TopLevelDomain
      - currentValue: TopLevelDomain
      - currentIndex: number
      - array: TopLevelDomain[]
      Returns TopLevelDomain
- initialValue: TopLevelDomain
Returns TopLevelDomain
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: TopLevelDomain, currentIndex: number, array: TopLevelDomain[]): U
    - Parameters
      - previousValue: U
      - currentValue: TopLevelDomain
      - currentIndex: number
      - array: TopLevelDomain[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): TopLevelDomain[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns TopLevelDomain[]

shift

shift(): TopLevelDomain | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns TopLevelDomain | undefined

slice

slice(start?: undefined | number, end?: undefined | number): TopLevelDomain[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns TopLevelDomain[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: TopLevelDomain, index: number, array: TopLevelDomain[]): boolean
    - Parameters
      - value: TopLevelDomain
      - index: number
      - array: TopLevelDomain[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): TopLevelDomain[]
splice(start: number, deleteCount: number, ...items: TopLevelDomain[]): TopLevelDomain[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns TopLevelDomain[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: TopLevelDomain[]
  
  Elements to insert into the array in place of the deleted elements.
Returns TopLevelDomain[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: TopLevelDomain[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: TopLevelDomain[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<TopLevelDomain>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<TopLevelDomain>

type

type: object

className

className: string = "TopLevelDomainCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "TopLevelDomain"

name

Const TriggeredJobHistory

TriggeredJobHistory: object

interface: An interface representing TriggeredJobHistory. Triggered Web Job History. List of Triggered Web Job Run Information elements.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runs

runs: TriggeredJobRun[]

member: {TriggeredJobRun[]} [runs] List of triggered web job runs.

serializedName

serializedName: string = "TriggeredJobHistory"

type

type: object

className

className: string = "TriggeredJobHistory"

name

modelProperties

modelProperties: object

runs

runs: object

serializedName

serializedName: string = "properties.runs"

type

type: object

name

element

element: object

type

type: object

className

className: string = "TriggeredJobRun"

name

Const TriggeredJobHistoryCollection

TriggeredJobHistoryCollection: object

interface: An interface representing the TriggeredJobHistoryCollection. Collection of Kudu continuous web job information elements.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TriggeredJobHistoryCollection"

__@iterator

__@iterator(): IterableIterator<TriggeredJobHistory>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<TriggeredJobHistory>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<TriggeredJobHistory>[]): TriggeredJobHistory[]
concat(...items: (T | ConcatArray<T>)[]): TriggeredJobHistory[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<TriggeredJobHistory>[]
 
 Additional items to add to the end of array1.
Returns TriggeredJobHistory[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns TriggeredJobHistory[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, TriggeredJobHistory]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, TriggeredJobHistory]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): boolean
    - Parameters
      - value: TriggeredJobHistory
      - index: number
      - array: TriggeredJobHistory[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: TriggeredJobHistory, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: TriggeredJobHistory
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): TriggeredJobHistory[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: TriggeredJobHistory
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): boolean
    - Parameters
      - value: TriggeredJobHistory
      - index: number
      - array: TriggeredJobHistory[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): any
    - Parameters
      - value: TriggeredJobHistory
      - index: number
      - array: TriggeredJobHistory[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns TriggeredJobHistory[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): TriggeredJobHistory | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: TriggeredJobHistory
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: TriggeredJobHistory, index: number, obj: TriggeredJobHistory[]): boolean
    - Parameters
      - this: void
      - value: TriggeredJobHistory
      - index: number
      - obj: TriggeredJobHistory[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: TriggeredJobHistory, index: number, obj: TriggeredJobHistory[]): boolean
    - Parameters
      - value: TriggeredJobHistory
      - index: number
      - obj: TriggeredJobHistory[]
      Returns boolean
- Optional thisArg: any
Returns TriggeredJobHistory | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: TriggeredJobHistory, index: number, obj: TriggeredJobHistory[]): boolean
    - Parameters
      - value: TriggeredJobHistory
      - index: number
      - obj: TriggeredJobHistory[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): void
    - Parameters
      - value: TriggeredJobHistory
      - index: number
      - array: TriggeredJobHistory[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: TriggeredJobHistory, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: TriggeredJobHistory
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: TriggeredJobHistory, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: TriggeredJobHistory
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: TriggeredJobHistory, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: TriggeredJobHistory
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): U
    - Parameters
      - value: TriggeredJobHistory
      - index: number
      - array: TriggeredJobHistory[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): TriggeredJobHistory | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns TriggeredJobHistory | undefined

push

push(...items: TriggeredJobHistory[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: TriggeredJobHistory[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): TriggeredJobHistory
reduce(callbackfn: function, initialValue: TriggeredJobHistory): TriggeredJobHistory
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: TriggeredJobHistory, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): TriggeredJobHistory
    - Parameters
      - previousValue: TriggeredJobHistory
      - currentValue: TriggeredJobHistory
      - currentIndex: number
      - array: TriggeredJobHistory[]
      Returns TriggeredJobHistory
Returns TriggeredJobHistory
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: TriggeredJobHistory, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): TriggeredJobHistory
    - Parameters
      - previousValue: TriggeredJobHistory
      - currentValue: TriggeredJobHistory
      - currentIndex: number
      - array: TriggeredJobHistory[]
      Returns TriggeredJobHistory
- initialValue: TriggeredJobHistory
Returns TriggeredJobHistory
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): U
    - Parameters
      - previousValue: U
      - currentValue: TriggeredJobHistory
      - currentIndex: number
      - array: TriggeredJobHistory[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): TriggeredJobHistory
reduceRight(callbackfn: function, initialValue: TriggeredJobHistory): TriggeredJobHistory
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: TriggeredJobHistory, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): TriggeredJobHistory
    - Parameters
      - previousValue: TriggeredJobHistory
      - currentValue: TriggeredJobHistory
      - currentIndex: number
      - array: TriggeredJobHistory[]
      Returns TriggeredJobHistory
Returns TriggeredJobHistory
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: TriggeredJobHistory, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): TriggeredJobHistory
    - Parameters
      - previousValue: TriggeredJobHistory
      - currentValue: TriggeredJobHistory
      - currentIndex: number
      - array: TriggeredJobHistory[]
      Returns TriggeredJobHistory
- initialValue: TriggeredJobHistory
Returns TriggeredJobHistory
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: TriggeredJobHistory, currentIndex: number, array: TriggeredJobHistory[]): U
    - Parameters
      - previousValue: U
      - currentValue: TriggeredJobHistory
      - currentIndex: number
      - array: TriggeredJobHistory[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): TriggeredJobHistory[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns TriggeredJobHistory[]

shift

shift(): TriggeredJobHistory | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns TriggeredJobHistory | undefined

slice

slice(start?: undefined | number, end?: undefined | number): TriggeredJobHistory[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns TriggeredJobHistory[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: TriggeredJobHistory, index: number, array: TriggeredJobHistory[]): boolean
    - Parameters
      - value: TriggeredJobHistory
      - index: number
      - array: TriggeredJobHistory[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): TriggeredJobHistory[]
splice(start: number, deleteCount: number, ...items: TriggeredJobHistory[]): TriggeredJobHistory[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns TriggeredJobHistory[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: TriggeredJobHistory[]
  
  Elements to insert into the array in place of the deleted elements.
Returns TriggeredJobHistory[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: TriggeredJobHistory[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: TriggeredJobHistory[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<TriggeredJobHistory>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<TriggeredJobHistory>

type

type: object

className

className: string = "TriggeredJobHistoryCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "TriggeredJobHistory"

name

Const TriggeredJobRun

TriggeredJobRun: object

interface: An interface representing TriggeredJobRun. Triggered Web Job Run Information.
extends: ProxyOnlyResource

Optional duration

duration: undefined | string

member: {string} [duration] Job duration.

Optional endTime

endTime: Date

member: {Date} [endTime] End time.

Optional errorUrl

errorUrl: undefined | string

member: {string} [errorUrl] Error URL.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional jobName

jobName: undefined | string

member: {string} [jobName] Job name.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputUrl

outputUrl: undefined | string

member: {string} [outputUrl] Output URL.

serializedName

serializedName: string = "TriggeredJobRun"

Optional startTime

startTime: Date

member: {Date} [startTime] Start time.

Optional status

status: TriggeredWebJobStatus

member: {TriggeredWebJobStatus} [status] Job status. Possible values include: 'Success', 'Failed', 'Error'

Optional trigger

trigger: undefined | string

member: {string} [trigger] Job trigger.

Optional url

url: undefined | string

member: {string} [url] Job URL.

Optional webJobId

webJobId: undefined | string

member: {string} [webJobId] Job ID.

Optional webJobName

webJobName: undefined | string

member: {string} [webJobName] Job name.

type

type: object

className

className: string = "TriggeredJobRun"

name

modelProperties

type

type: object

name

Const TriggeredWebJob

TriggeredWebJob: object

interface: An interface representing TriggeredWebJob. Triggered Web Job Information.
extends: ProxyOnlyResource

Optional error

error: undefined | string

member: {string} [error] Error information.

Optional extraInfoUrl

extraInfoUrl: undefined | string

member: {string} [extraInfoUrl] Extra Info URL.

Optional historyUrl

historyUrl: undefined | string

member: {string} [historyUrl] History URL.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional latestRun

latestRun: TriggeredJobRun

member: {TriggeredJobRun} [latestRun] Latest job run information.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runCommand

runCommand: undefined | string

member: {string} [runCommand] Run command.

Optional schedulerLogsUrl

schedulerLogsUrl: undefined | string

member: {string} [schedulerLogsUrl] Scheduler Logs URL.

serializedName

serializedName: string = "TriggeredWebJob"

Optional settings

settings: undefined | object

member: {{ [propertyName: string]: any }} [settings] Job settings.

Optional url

url: undefined | string

member: {string} [url] Job URL.

Optional usingSdk

usingSdk: undefined | false | true

member: {boolean} [usingSdk] Using SDK?

Optional webJobType

webJobType: WebJobType

member: {WebJobType} [webJobType] Job type. Possible values include: 'Continuous', 'Triggered'

type

type: object

className

className: string = "TriggeredWebJob"

name

modelProperties

allowedValues

allowedValues: string[] = ["Continuous","Triggered"]

name

Const TriggeredWebJobCollection

TriggeredWebJobCollection: object

interface: An interface representing the TriggeredWebJobCollection. Collection of Kudu continuous web job information elements.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "TriggeredWebJobCollection"

__@iterator

__@iterator(): IterableIterator<TriggeredWebJob>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<TriggeredWebJob>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<TriggeredWebJob>[]): TriggeredWebJob[]
concat(...items: (T | ConcatArray<T>)[]): TriggeredWebJob[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<TriggeredWebJob>[]
 
 Additional items to add to the end of array1.
Returns TriggeredWebJob[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns TriggeredWebJob[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, TriggeredWebJob]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, TriggeredWebJob]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): boolean
    - Parameters
      - value: TriggeredWebJob
      - index: number
      - array: TriggeredWebJob[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: TriggeredWebJob, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: TriggeredWebJob
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): TriggeredWebJob[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: TriggeredWebJob
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): boolean
    - Parameters
      - value: TriggeredWebJob
      - index: number
      - array: TriggeredWebJob[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): any
    - Parameters
      - value: TriggeredWebJob
      - index: number
      - array: TriggeredWebJob[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns TriggeredWebJob[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): TriggeredWebJob | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: TriggeredWebJob
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: TriggeredWebJob, index: number, obj: TriggeredWebJob[]): boolean
    - Parameters
      - this: void
      - value: TriggeredWebJob
      - index: number
      - obj: TriggeredWebJob[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: TriggeredWebJob, index: number, obj: TriggeredWebJob[]): boolean
    - Parameters
      - value: TriggeredWebJob
      - index: number
      - obj: TriggeredWebJob[]
      Returns boolean
- Optional thisArg: any
Returns TriggeredWebJob | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: TriggeredWebJob, index: number, obj: TriggeredWebJob[]): boolean
    - Parameters
      - value: TriggeredWebJob
      - index: number
      - obj: TriggeredWebJob[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): void
    - Parameters
      - value: TriggeredWebJob
      - index: number
      - array: TriggeredWebJob[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: TriggeredWebJob, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: TriggeredWebJob
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: TriggeredWebJob, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: TriggeredWebJob
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: TriggeredWebJob, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: TriggeredWebJob
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): U
    - Parameters
      - value: TriggeredWebJob
      - index: number
      - array: TriggeredWebJob[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): TriggeredWebJob | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns TriggeredWebJob | undefined

push

push(...items: TriggeredWebJob[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: TriggeredWebJob[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): TriggeredWebJob
reduce(callbackfn: function, initialValue: TriggeredWebJob): TriggeredWebJob
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: TriggeredWebJob, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): TriggeredWebJob
    - Parameters
      - previousValue: TriggeredWebJob
      - currentValue: TriggeredWebJob
      - currentIndex: number
      - array: TriggeredWebJob[]
      Returns TriggeredWebJob
Returns TriggeredWebJob
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: TriggeredWebJob, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): TriggeredWebJob
    - Parameters
      - previousValue: TriggeredWebJob
      - currentValue: TriggeredWebJob
      - currentIndex: number
      - array: TriggeredWebJob[]
      Returns TriggeredWebJob
- initialValue: TriggeredWebJob
Returns TriggeredWebJob
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): U
    - Parameters
      - previousValue: U
      - currentValue: TriggeredWebJob
      - currentIndex: number
      - array: TriggeredWebJob[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): TriggeredWebJob
reduceRight(callbackfn: function, initialValue: TriggeredWebJob): TriggeredWebJob
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: TriggeredWebJob, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): TriggeredWebJob
    - Parameters
      - previousValue: TriggeredWebJob
      - currentValue: TriggeredWebJob
      - currentIndex: number
      - array: TriggeredWebJob[]
      Returns TriggeredWebJob
Returns TriggeredWebJob
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: TriggeredWebJob, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): TriggeredWebJob
    - Parameters
      - previousValue: TriggeredWebJob
      - currentValue: TriggeredWebJob
      - currentIndex: number
      - array: TriggeredWebJob[]
      Returns TriggeredWebJob
- initialValue: TriggeredWebJob
Returns TriggeredWebJob
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: TriggeredWebJob, currentIndex: number, array: TriggeredWebJob[]): U
    - Parameters
      - previousValue: U
      - currentValue: TriggeredWebJob
      - currentIndex: number
      - array: TriggeredWebJob[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): TriggeredWebJob[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns TriggeredWebJob[]

shift

shift(): TriggeredWebJob | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns TriggeredWebJob | undefined

slice

slice(start?: undefined | number, end?: undefined | number): TriggeredWebJob[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns TriggeredWebJob[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: TriggeredWebJob, index: number, array: TriggeredWebJob[]): boolean
    - Parameters
      - value: TriggeredWebJob
      - index: number
      - array: TriggeredWebJob[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): TriggeredWebJob[]
splice(start: number, deleteCount: number, ...items: TriggeredWebJob[]): TriggeredWebJob[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns TriggeredWebJob[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: TriggeredWebJob[]
  
  Elements to insert into the array in place of the deleted elements.
Returns TriggeredWebJob[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: TriggeredWebJob[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: TriggeredWebJob[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<TriggeredWebJob>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<TriggeredWebJob>

type

type: object

className

className: string = "TriggeredWebJobCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "TriggeredWebJob"

name

Const Usage

Usage: object

interface: An interface representing Usage. Usage of the quota resource.
extends: ProxyOnlyResource

Optional computeMode

computeMode: ComputeModeOptions

member: {ComputeModeOptions} [computeMode] Compute mode used for this usage. Possible values include: 'Shared', 'Dedicated', 'Dynamic' NOTE: This property will not be serialized. It can only be populated by the server.

Optional currentValue

currentValue: undefined | number

member: {number} [currentValue] The current value of the resource counter. NOTE: This property will not be serialized. It can only be populated by the server.

Optional displayName

displayName: undefined | string

member: {string} [displayName] Friendly name shown in the UI. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional limit

limit: undefined | number

member: {number} [limit] The resource limit. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextResetTime

nextResetTime: Date

member: {Date} [nextResetTime] Next reset time for the resource counter. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resourceName

resourceName: undefined | string

member: {string} [resourceName] Name of the quota resource. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Usage"

Optional siteMode

siteMode: undefined | string

member: {string} [siteMode] Site mode used for this usage. NOTE: This property will not be serialized. It can only be populated by the server.

Optional unit

unit: undefined | string

member: {string} [unit] Units of measurement for the quota resource. NOTE: This property will not be serialized. It can only be populated by the server.

type

type: object

className

className: string = "Usage"

name

modelProperties

modelProperties: object

computeMode

name

Const UsageCollection

UsageCollection: object

interface: An interface representing the UsageCollection. Collection of usages.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "UsageCollection"

__@iterator

__@iterator(): IterableIterator<Usage>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<Usage>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<Usage>[]): Usage[]
concat(...items: (T | ConcatArray<T>)[]): Usage[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<Usage>[]
 
 Additional items to add to the end of array1.
Returns Usage[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns Usage[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, Usage]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, Usage]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: Usage, index: number, array: Usage[]): boolean
    - Parameters
      - value: Usage
      - index: number
      - array: Usage[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: Usage, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: Usage
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): Usage[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: Usage
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Usage, index: number, array: Usage[]): boolean
    - Parameters
      - value: Usage
      - index: number
      - array: Usage[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Usage, index: number, array: Usage[]): any
    - Parameters
      - value: Usage
      - index: number
      - array: Usage[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Usage[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): Usage | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: Usage
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: Usage, index: number, obj: Usage[]): boolean
    - Parameters
      - this: void
      - value: Usage
      - index: number
      - obj: Usage[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: Usage, index: number, obj: Usage[]): boolean
    - Parameters
      - value: Usage
      - index: number
      - obj: Usage[]
      Returns boolean
- Optional thisArg: any
Returns Usage | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: Usage, index: number, obj: Usage[]): boolean
    - Parameters
      - value: Usage
      - index: number
      - obj: Usage[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: Usage, index: number, array: Usage[]): void
    - Parameters
      - value: Usage
      - index: number
      - array: Usage[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: Usage, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: Usage
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: Usage, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: Usage
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: Usage, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: Usage
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: Usage, index: number, array: Usage[]): U
    - Parameters
      - value: Usage
      - index: number
      - array: Usage[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): Usage | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns Usage | undefined

push

push(...items: Usage[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: Usage[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): Usage
reduce(callbackfn: function, initialValue: Usage): Usage
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Usage, currentValue: Usage, currentIndex: number, array: Usage[]): Usage
    - Parameters
      - previousValue: Usage
      - currentValue: Usage
      - currentIndex: number
      - array: Usage[]
      Returns Usage
Returns Usage
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: Usage, currentValue: Usage, currentIndex: number, array: Usage[]): Usage
    - Parameters
      - previousValue: Usage
      - currentValue: Usage
      - currentIndex: number
      - array: Usage[]
      Returns Usage
- initialValue: Usage
Returns Usage
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Usage, currentIndex: number, array: Usage[]): U
    - Parameters
      - previousValue: U
      - currentValue: Usage
      - currentIndex: number
      - array: Usage[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): Usage
reduceRight(callbackfn: function, initialValue: Usage): Usage
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Usage, currentValue: Usage, currentIndex: number, array: Usage[]): Usage
    - Parameters
      - previousValue: Usage
      - currentValue: Usage
      - currentIndex: number
      - array: Usage[]
      Returns Usage
Returns Usage
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: Usage, currentValue: Usage, currentIndex: number, array: Usage[]): Usage
    - Parameters
      - previousValue: Usage
      - currentValue: Usage
      - currentIndex: number
      - array: Usage[]
      Returns Usage
- initialValue: Usage
Returns Usage
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Usage, currentIndex: number, array: Usage[]): U
    - Parameters
      - previousValue: U
      - currentValue: Usage
      - currentIndex: number
      - array: Usage[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): Usage[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns Usage[]

shift

shift(): Usage | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns Usage | undefined

slice

slice(start?: undefined | number, end?: undefined | number): Usage[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns Usage[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: Usage, index: number, array: Usage[]): boolean
    - Parameters
      - value: Usage
      - index: number
      - array: Usage[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): Usage[]
splice(start: number, deleteCount: number, ...items: Usage[]): Usage[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns Usage[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: Usage[]
  
  Elements to insert into the array in place of the deleted elements.
Returns Usage[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: Usage[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: Usage[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<Usage>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<Usage>

type

type: object

className

className: string = "UsageCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "Usage"

name

Const User

User: object

interface: An interface representing User. User crendentials used for publishing activity.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publishingPassword

publishingPassword: undefined | string

member: {string} [publishingPassword] Password used for publishing.

Optional publishingPasswordHash

publishingPasswordHash: undefined | string

member: {string} [publishingPasswordHash] Password hash used for publishing.

Optional publishingPasswordHashSalt

publishingPasswordHashSalt: undefined | string

member: {string} [publishingPasswordHashSalt] Password hash salt used for publishing.

publishingUserName

publishingUserName: string

member: {string} publishingUserName Username used for publishing.

Optional scmUri

scmUri: undefined | string

member: {string} [scmUri] Url of SCM site.

serializedName

serializedName: string = "User"

type

type: object

className

className: string = "User"

name

modelProperties

type

type: object

name

scmUri

scmUri: object

serializedName

serializedName: string = "properties.scmUri"

type

type: object

name

Const ValidateRequest

ValidateRequest: object

interface: An interface representing ValidateRequest. Resource validation request content.

Optional capacity

capacity: undefined | number

member: {number} [capacity] Target capacity of the App Service plan (number of VM's).

Optional hostingEnvironment

hostingEnvironment: undefined | string

member: {string} [hostingEnvironment] Name of App Service Environment where app or App Service plan should be created.

Optional isSpot

isSpot: undefined | false | true

member: {boolean} [isSpot] true if App Service plan is for Spot instances; otherwise, false.

Optional isXenon

isXenon: undefined | false | true

member: {boolean} [isXenon] true if App Service plan is running as a windows container

location

location: string

member: {string} location Expected location of the resource.

name

member: {string} name Resource name to verify.

Optional needLinuxWorkers

needLinuxWorkers: undefined | false | true

member: {boolean} [needLinuxWorkers] true if App Service plan is for Linux workers; otherwise, false.

serializedName

serializedName: string = "ValidateRequest"

Optional serverFarmId

serverFarmId: undefined | string

member: {string} [serverFarmId] ARM resource ID of an App Service plan that would host the app.

Optional skuName

skuName: undefined | string

member: {string} [skuName] Name of the target SKU for the App Service plan.

type

type: object

member: {ValidateResourceTypes} type Resource type used for verification. Possible values include: 'ServerFarm', 'Site'

className

className: string = "ValidateRequest"

name

modelProperties

modelProperties: object

capacity

capacity: object

serializedName

type

type: object

serializedName: string = "type"

type

type: object

name

Const ValidateResponse

ValidateResponse: object

interface: An interface representing ValidateResponse. Describes the result of resource validation.

Optional error

error: ValidateResponseError

member: {ValidateResponseError} [error] Error details for the case when validation fails.

serializedName

serializedName: string = "ValidateResponse"

Optional status

status: undefined | string

member: {string} [status] Result of validation.

type

type: object

className

className: string = "ValidateResponse"

name

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ValidateResponseError"

name

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

Const ValidateResponseError

ValidateResponseError: object

interface: An interface representing ValidateResponseError. Error details for when validation fails.

Optional code

code: undefined | string

member: {string} [code] Validation error code.

Optional message

message: undefined | string

member: {string} [message] Validation error message.

serializedName

serializedName: string = "ValidateResponseError"

type

type: object

className

className: string = "ValidateResponseError"

name

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

Const VirtualApplication

VirtualApplication: object

interface: An interface representing VirtualApplication. Virtual application in an app.

Optional physicalPath

physicalPath: undefined | string

member: {string} [physicalPath] Physical path.

Optional preloadEnabled

preloadEnabled: undefined | false | true

member: {boolean} [preloadEnabled] true if preloading is enabled; otherwise, false.

serializedName

serializedName: string = "VirtualApplication"

Optional virtualDirectories

virtualDirectories: VirtualDirectory[]

member: {VirtualDirectory[]} [virtualDirectories] Virtual directories for virtual application.

Optional virtualPath

virtualPath: undefined | string

member: {string} [virtualPath] Virtual path.

type

type: object

className

className: string = "VirtualApplication"

name

modelProperties

name

Const VirtualDirectory

VirtualDirectory: object

interface: An interface representing VirtualDirectory. Directory for virtual application.

Optional physicalPath

physicalPath: undefined | string

member: {string} [physicalPath] Physical path.

serializedName

serializedName: string = "VirtualDirectory"

Optional virtualPath

virtualPath: undefined | string

member: {string} [virtualPath] Path to virtual application.

type

type: object

className

className: string = "VirtualDirectory"

name

modelProperties

modelProperties: object

physicalPath

physicalPath: object

serializedName

serializedName: string = "physicalPath"

type

type: object

name

virtualPath

virtualPath: object

serializedName

serializedName: string = "virtualPath"

type

type: object

name

Const VirtualIPMapping

VirtualIPMapping: object

interface: An interface representing VirtualIPMapping. Virtual IP mapping.

Optional inUse

inUse: undefined | false | true

member: {boolean} [inUse] Is virtual IP mapping in use.

Optional internalHttpPort

internalHttpPort: undefined | number

member: {number} [internalHttpPort] Internal HTTP port.

Optional internalHttpsPort

internalHttpsPort: undefined | number

member: {number} [internalHttpsPort] Internal HTTPS port.

serializedName

serializedName: string = "VirtualIPMapping"

Optional virtualIP

virtualIP: undefined | string

member: {string} [virtualIP] Virtual IP address.

type

type: object

className

className: string = "VirtualIPMapping"

name

modelProperties

name

Const VirtualNetworkProfile

VirtualNetworkProfile: object

interface: An interface representing VirtualNetworkProfile. Specification for using a Virtual Network.

Optional id

id: undefined | string

member: {string} [id] Resource id of the Virtual Network.

Optional name

member: {string} [name] Name of the Virtual Network (read-only). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VirtualNetworkProfile"

Optional subnet

subnet: undefined | string

member: {string} [subnet] Subnet within the Virtual Network.

type

type: object

member: {string} [type] Resource type of the Virtual Network (read-only). NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "VirtualNetworkProfile"

name

subnet: object

serializedName

serializedName: string = "subnet"

type

type: object

name

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

Const VnetGateway

VnetGateway: object

interface: An interface representing VnetGateway. The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VnetGateway"

Optional vnetName

vnetName: undefined | string

member: {string} [vnetName] The Virtual Network name.

vpnPackageUri

vpnPackageUri: string

member: {string} vpnPackageUri The URI where the VPN package can be downloaded.

type

type: object

className

className: string = "VnetGateway"

name

modelProperties

modelProperties: object

vnetName

vnetName: object

serializedName

serializedName: string = "properties.vnetName"

type

type: object

name

vpnPackageUri

vpnPackageUri: object

required

required: true = true

serializedName

serializedName: string = "properties.vpnPackageUri"

type

type: object

name

Const VnetInfo

VnetInfo: object

interface: An interface representing VnetInfo. Virtual Network information contract.
extends: ProxyOnlyResource

Optional certBlob

certBlob: Uint8Array

member: {Uint8Array} [certBlob] A certificate file (.cer) blob containing the public key of the private key used to authenticate a Point-To-Site VPN connection.

Optional certThumbprint

certThumbprint: undefined | string

member: {string} [certThumbprint] The client certificate thumbprint. NOTE: This property will not be serialized. It can only be populated by the server.

Optional dnsServers

dnsServers: undefined | string

member: {string} [dnsServers] DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional resyncRequired

resyncRequired: undefined | false | true

member: {boolean} [resyncRequired] true if a resync is required; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

Optional routes

routes: VnetRoute[]

member: {VnetRoute[]} [routes] The routes that this Virtual Network connection uses. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VnetInfo"

Optional vnetResourceId

vnetResourceId: undefined | string

member: {string} [vnetResourceId] The Virtual Network's resource ID.

type

type: object

className

className: string = "VnetInfo"

name

modelProperties

modelProperties: object

certBlob

certBlob: object

serializedName

serializedName: string = "properties.certBlob"

type

type: object

name

certThumbprint

type

type: object

name

routes

name

Const VnetParameters

VnetParameters: object

interface: An interface representing VnetParameters. The required set of inputs to validate a VNET
extends: ProxyOnlyResource

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VnetParameters"

Optional vnetName

vnetName: undefined | string

member: {string} [vnetName] The name of the VNET to be validated

Optional vnetResourceGroup

vnetResourceGroup: undefined | string

member: {string} [vnetResourceGroup] The Resource Group of the VNET to be validated

Optional vnetSubnetName

vnetSubnetName: undefined | string

member: {string} [vnetSubnetName] The subnet name to be validated

type

type: object

className

className: string = "VnetParameters"

name

modelProperties

name

Const VnetRoute

VnetRoute: object

interface: An interface representing VnetRoute. Virtual Network route contract used to pass routing information for a Virtual Network.
extends: ProxyOnlyResource

Optional endAddress

endAddress: undefined | string

member: {string} [endAddress] The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional routeType

routeType: RouteType

member

{RouteType} [routeType] The type of route this is: DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 INHERITED - Routes inherited from the real Virtual Network routes STATIC - Static route set on the app only

These values will be used for syncing an app's routes with those from a Virtual Network. Possible values include: 'DEFAULT', 'INHERITED', 'STATIC'

serializedName

serializedName: string = "VnetRoute"

Optional startAddress

startAddress: undefined | string

member: {string} [startAddress] The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.

type

type: object

className

className: string = "VnetRoute"

name

modelProperties

name

Const VnetValidationFailureDetails

VnetValidationFailureDetails: object

interface: An interface representing VnetValidationFailureDetails. A class that describes the reason for a validation failure.
extends: ProxyOnlyResource

Optional failed

failed: undefined | false | true

member: {boolean} [failed] A flag describing whether or not validation failed.

Optional failedTests

failedTests: VnetValidationTestFailure[]

member: {VnetValidationTestFailure[]} [failedTests] A list of tests that failed in the validation.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VnetValidationFailureDetails"

type

type: object

className

className: string = "VnetValidationFailureDetails"

name

modelProperties

name

Const VnetValidationTestFailure

VnetValidationTestFailure: object

interface: An interface representing VnetValidationTestFailure. A class that describes a test that failed during NSG and UDR validation.
extends: ProxyOnlyResource

Optional details

details: undefined | string

member: {string} [details] The details of what caused the failure, e.g. the blocking rule name, etc.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "VnetValidationTestFailure"

Optional testName

testName: undefined | string

member: {string} [testName] The name of the test that failed.

type

type: object

className

className: string = "VnetValidationTestFailure"

name

modelProperties

modelProperties: object

details

details: object

serializedName

serializedName: string = "properties.details"

type

type: object

name

testName

testName: object

serializedName

serializedName: string = "properties.testName"

type

type: object

name

Const WebAppCollection

WebAppCollection: object

interface: An interface representing the WebAppCollection. Collection of App Service apps.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WebAppCollection"

__@iterator

__@iterator(): IterableIterator<Site>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<Site>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<Site>[]): Site[]
concat(...items: (T | ConcatArray<T>)[]): Site[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<Site>[]
 
 Additional items to add to the end of array1.
Returns Site[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns Site[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, Site]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, Site]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: Site, index: number, array: Site[]): boolean
    - Parameters
      - value: Site
      - index: number
      - array: Site[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: Site, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: Site
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): Site[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: Site
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Site, index: number, array: Site[]): boolean
    - Parameters
      - value: Site
      - index: number
      - array: Site[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: Site, index: number, array: Site[]): any
    - Parameters
      - value: Site
      - index: number
      - array: Site[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns Site[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): Site | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: Site
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: Site, index: number, obj: Site[]): boolean
    - Parameters
      - this: void
      - value: Site
      - index: number
      - obj: Site[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: Site, index: number, obj: Site[]): boolean
    - Parameters
      - value: Site
      - index: number
      - obj: Site[]
      Returns boolean
- Optional thisArg: any
Returns Site | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: Site, index: number, obj: Site[]): boolean
    - Parameters
      - value: Site
      - index: number
      - obj: Site[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: Site, index: number, array: Site[]): void
    - Parameters
      - value: Site
      - index: number
      - array: Site[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: Site, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: Site
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: Site, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: Site
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: Site, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: Site
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: Site, index: number, array: Site[]): U
    - Parameters
      - value: Site
      - index: number
      - array: Site[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): Site | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns Site | undefined

push

push(...items: Site[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: Site[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): Site
reduce(callbackfn: function, initialValue: Site): Site
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Site, currentValue: Site, currentIndex: number, array: Site[]): Site
    - Parameters
      - previousValue: Site
      - currentValue: Site
      - currentIndex: number
      - array: Site[]
      Returns Site
Returns Site
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: Site, currentValue: Site, currentIndex: number, array: Site[]): Site
    - Parameters
      - previousValue: Site
      - currentValue: Site
      - currentIndex: number
      - array: Site[]
      Returns Site
- initialValue: Site
Returns Site
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Site, currentIndex: number, array: Site[]): U
    - Parameters
      - previousValue: U
      - currentValue: Site
      - currentIndex: number
      - array: Site[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): Site
reduceRight(callbackfn: function, initialValue: Site): Site
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: Site, currentValue: Site, currentIndex: number, array: Site[]): Site
    - Parameters
      - previousValue: Site
      - currentValue: Site
      - currentIndex: number
      - array: Site[]
      Returns Site
Returns Site
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: Site, currentValue: Site, currentIndex: number, array: Site[]): Site
    - Parameters
      - previousValue: Site
      - currentValue: Site
      - currentIndex: number
      - array: Site[]
      Returns Site
- initialValue: Site
Returns Site
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: Site, currentIndex: number, array: Site[]): U
    - Parameters
      - previousValue: U
      - currentValue: Site
      - currentIndex: number
      - array: Site[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): Site[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns Site[]

shift

shift(): Site | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns Site | undefined

slice

slice(start?: undefined | number, end?: undefined | number): Site[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns Site[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: Site, index: number, array: Site[]): boolean
    - Parameters
      - value: Site
      - index: number
      - array: Site[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): Site[]
splice(start: number, deleteCount: number, ...items: Site[]): Site[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns Site[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: Site[]
  
  Elements to insert into the array in place of the deleted elements.
Returns Site[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: Site[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: Site[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<Site>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<Site>

type

type: object

className

className: string = "WebAppCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "Site"

name

Const WebAppInstanceCollection

WebAppInstanceCollection: object

interface: An interface representing the WebAppInstanceCollection. Collection of app instances.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WebAppInstanceCollection"

__@iterator

__@iterator(): IterableIterator<SiteInstance>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<SiteInstance>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<SiteInstance>[]): SiteInstance[]
concat(...items: (T | ConcatArray<T>)[]): SiteInstance[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<SiteInstance>[]
 
 Additional items to add to the end of array1.
Returns SiteInstance[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns SiteInstance[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, SiteInstance]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, SiteInstance]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: SiteInstance, index: number, array: SiteInstance[]): boolean
    - Parameters
      - value: SiteInstance
      - index: number
      - array: SiteInstance[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: SiteInstance, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: SiteInstance
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): SiteInstance[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: SiteInstance
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SiteInstance, index: number, array: SiteInstance[]): boolean
    - Parameters
      - value: SiteInstance
      - index: number
      - array: SiteInstance[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: SiteInstance, index: number, array: SiteInstance[]): any
    - Parameters
      - value: SiteInstance
      - index: number
      - array: SiteInstance[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns SiteInstance[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): SiteInstance | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: SiteInstance
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: SiteInstance, index: number, obj: SiteInstance[]): boolean
    - Parameters
      - this: void
      - value: SiteInstance
      - index: number
      - obj: SiteInstance[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: SiteInstance, index: number, obj: SiteInstance[]): boolean
    - Parameters
      - value: SiteInstance
      - index: number
      - obj: SiteInstance[]
      Returns boolean
- Optional thisArg: any
Returns SiteInstance | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: SiteInstance, index: number, obj: SiteInstance[]): boolean
    - Parameters
      - value: SiteInstance
      - index: number
      - obj: SiteInstance[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: SiteInstance, index: number, array: SiteInstance[]): void
    - Parameters
      - value: SiteInstance
      - index: number
      - array: SiteInstance[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: SiteInstance, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: SiteInstance
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: SiteInstance, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: SiteInstance
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: SiteInstance, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: SiteInstance
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: SiteInstance, index: number, array: SiteInstance[]): U
    - Parameters
      - value: SiteInstance
      - index: number
      - array: SiteInstance[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): SiteInstance | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns SiteInstance | undefined

push

push(...items: SiteInstance[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: SiteInstance[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): SiteInstance
reduce(callbackfn: function, initialValue: SiteInstance): SiteInstance
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SiteInstance, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): SiteInstance
    - Parameters
      - previousValue: SiteInstance
      - currentValue: SiteInstance
      - currentIndex: number
      - array: SiteInstance[]
      Returns SiteInstance
Returns SiteInstance
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: SiteInstance, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): SiteInstance
    - Parameters
      - previousValue: SiteInstance
      - currentValue: SiteInstance
      - currentIndex: number
      - array: SiteInstance[]
      Returns SiteInstance
- initialValue: SiteInstance
Returns SiteInstance
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): U
    - Parameters
      - previousValue: U
      - currentValue: SiteInstance
      - currentIndex: number
      - array: SiteInstance[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): SiteInstance
reduceRight(callbackfn: function, initialValue: SiteInstance): SiteInstance
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: SiteInstance, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): SiteInstance
    - Parameters
      - previousValue: SiteInstance
      - currentValue: SiteInstance
      - currentIndex: number
      - array: SiteInstance[]
      Returns SiteInstance
Returns SiteInstance
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: SiteInstance, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): SiteInstance
    - Parameters
      - previousValue: SiteInstance
      - currentValue: SiteInstance
      - currentIndex: number
      - array: SiteInstance[]
      Returns SiteInstance
- initialValue: SiteInstance
Returns SiteInstance
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: SiteInstance, currentIndex: number, array: SiteInstance[]): U
    - Parameters
      - previousValue: U
      - currentValue: SiteInstance
      - currentIndex: number
      - array: SiteInstance[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): SiteInstance[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns SiteInstance[]

shift

shift(): SiteInstance | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns SiteInstance | undefined

slice

slice(start?: undefined | number, end?: undefined | number): SiteInstance[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns SiteInstance[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: SiteInstance, index: number, array: SiteInstance[]): boolean
    - Parameters
      - value: SiteInstance
      - index: number
      - array: SiteInstance[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): SiteInstance[]
splice(start: number, deleteCount: number, ...items: SiteInstance[]): SiteInstance[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns SiteInstance[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: SiteInstance[]
  
  Elements to insert into the array in place of the deleted elements.
Returns SiteInstance[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: SiteInstance[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: SiteInstance[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<SiteInstance>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<SiteInstance>

type

type: object

className

className: string = "WebAppInstanceCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "SiteInstance"

name

Const WebJob

WebJob: object

interface: An interface representing WebJob. Web Job Information.
extends: ProxyOnlyResource

Optional error

error: undefined | string

member: {string} [error] Error information.

Optional extraInfoUrl

extraInfoUrl: undefined | string

member: {string} [extraInfoUrl] Extra Info URL.

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional runCommand

runCommand: undefined | string

member: {string} [runCommand] Run command.

serializedName

serializedName: string = "WebJob"

Optional settings

settings: undefined | object

member: {{ [propertyName: string]: any }} [settings] Job settings.

Optional url

url: undefined | string

member: {string} [url] Job URL.

Optional usingSdk

usingSdk: undefined | false | true

member: {boolean} [usingSdk] Using SDK?

Optional webJobType

webJobType: WebJobType

member: {WebJobType} [webJobType] Job type. Possible values include: 'Continuous', 'Triggered'

type

type: object

className

className: string = "WebJob"

name

modelProperties

webJobType: object

serializedName

serializedName: string = "properties.web_job_type"

type

type: object

allowedValues

allowedValues: string[] = ["Continuous","Triggered"]

name

Const WebJobCollection

WebJobCollection: object

interface: An interface representing the WebJobCollection. Collection of Kudu web job information elements.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WebJobCollection"

__@iterator

__@iterator(): IterableIterator<WebJob>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<WebJob>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<WebJob>[]): WebJob[]
concat(...items: (T | ConcatArray<T>)[]): WebJob[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<WebJob>[]
 
 Additional items to add to the end of array1.
Returns WebJob[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns WebJob[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, WebJob]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, WebJob]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: WebJob, index: number, array: WebJob[]): boolean
    - Parameters
      - value: WebJob
      - index: number
      - array: WebJob[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: WebJob, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: WebJob
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): WebJob[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: WebJob
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: WebJob, index: number, array: WebJob[]): boolean
    - Parameters
      - value: WebJob
      - index: number
      - array: WebJob[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: WebJob, index: number, array: WebJob[]): any
    - Parameters
      - value: WebJob
      - index: number
      - array: WebJob[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns WebJob[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): WebJob | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: WebJob
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: WebJob, index: number, obj: WebJob[]): boolean
    - Parameters
      - this: void
      - value: WebJob
      - index: number
      - obj: WebJob[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: WebJob, index: number, obj: WebJob[]): boolean
    - Parameters
      - value: WebJob
      - index: number
      - obj: WebJob[]
      Returns boolean
- Optional thisArg: any
Returns WebJob | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: WebJob, index: number, obj: WebJob[]): boolean
    - Parameters
      - value: WebJob
      - index: number
      - obj: WebJob[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: WebJob, index: number, array: WebJob[]): void
    - Parameters
      - value: WebJob
      - index: number
      - array: WebJob[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: WebJob, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: WebJob
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: WebJob, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: WebJob
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: WebJob, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: WebJob
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: WebJob, index: number, array: WebJob[]): U
    - Parameters
      - value: WebJob
      - index: number
      - array: WebJob[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): WebJob | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns WebJob | undefined

push

push(...items: WebJob[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: WebJob[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): WebJob
reduce(callbackfn: function, initialValue: WebJob): WebJob
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: WebJob, currentValue: WebJob, currentIndex: number, array: WebJob[]): WebJob
    - Parameters
      - previousValue: WebJob
      - currentValue: WebJob
      - currentIndex: number
      - array: WebJob[]
      Returns WebJob
Returns WebJob
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: WebJob, currentValue: WebJob, currentIndex: number, array: WebJob[]): WebJob
    - Parameters
      - previousValue: WebJob
      - currentValue: WebJob
      - currentIndex: number
      - array: WebJob[]
      Returns WebJob
- initialValue: WebJob
Returns WebJob
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: WebJob, currentIndex: number, array: WebJob[]): U
    - Parameters
      - previousValue: U
      - currentValue: WebJob
      - currentIndex: number
      - array: WebJob[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): WebJob
reduceRight(callbackfn: function, initialValue: WebJob): WebJob
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: WebJob, currentValue: WebJob, currentIndex: number, array: WebJob[]): WebJob
    - Parameters
      - previousValue: WebJob
      - currentValue: WebJob
      - currentIndex: number
      - array: WebJob[]
      Returns WebJob
Returns WebJob
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: WebJob, currentValue: WebJob, currentIndex: number, array: WebJob[]): WebJob
    - Parameters
      - previousValue: WebJob
      - currentValue: WebJob
      - currentIndex: number
      - array: WebJob[]
      Returns WebJob
- initialValue: WebJob
Returns WebJob
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: WebJob, currentIndex: number, array: WebJob[]): U
    - Parameters
      - previousValue: U
      - currentValue: WebJob
      - currentIndex: number
      - array: WebJob[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): WebJob[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns WebJob[]

shift

shift(): WebJob | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns WebJob | undefined

slice

slice(start?: undefined | number, end?: undefined | number): WebJob[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns WebJob[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: WebJob, index: number, array: WebJob[]): boolean
    - Parameters
      - value: WebJob
      - index: number
      - array: WebJob[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): WebJob[]
splice(start: number, deleteCount: number, ...items: WebJob[]): WebJob[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns WebJob[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: WebJob[]
  
  Elements to insert into the array in place of the deleted elements.
Returns WebJob[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: WebJob[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: WebJob[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<WebJob>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<WebJob>

type

type: object

className

className: string = "WebJobCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "WebJob"

name

Const WorkerPool

WorkerPool: object

interface: An interface representing WorkerPool. Worker pool of an App Service Environment.

Optional computeMode

computeMode: ComputeModeOptions

member: {ComputeModeOptions} [computeMode] Shared or dedicated app hosting. Possible values include: 'Shared', 'Dedicated', 'Dynamic'

Optional instanceNames

instanceNames: string[]

member: {string[]} [instanceNames] Names of all instances in the worker pool (read only). NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkerPool"

Optional workerCount

workerCount: undefined | number

member: {number} [workerCount] Number of instances in the worker pool.

Optional workerSize

workerSize: undefined | string

member: {string} [workerSize] VM size of the worker pool instances.

Optional workerSizeId

workerSizeId: undefined | number

member: {number} [workerSizeId] Worker size ID for referencing this worker pool.

type

type: object

className

className: string = "WorkerPool"

name

modelProperties

modelProperties: object

computeMode

computeMode: object

serializedName

WorkerPoolCollection: object

interface: An interface representing the WorkerPoolCollection. Collection of worker pools.
extends: Array

Const Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

member: {string} [nextLink] Link to next page of resources. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkerPoolCollection"

__@iterator

__@iterator(): IterableIterator<WorkerPoolResource>

Inherited from Array.[Symbol.iterator]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:52
Iterator

Returns IterableIterator<WorkerPoolResource>

__@unscopables

__@unscopables(): object

Inherited from Array.[Symbol.unscopables]
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:94
Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Returns object

concat

concat(...items: ConcatArray<WorkerPoolResource>[]): WorkerPoolResource[]
concat(...items: (T | ConcatArray<T>)[]): WorkerPoolResource[]

Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1221
Combines two or more arrays.

Parameters
- Rest ...items: ConcatArray<WorkerPoolResource>[]
 
 Additional items to add to the end of array1.
Returns WorkerPoolResource[]
Inherited from Array.concat
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1226
Combines two or more arrays.

Parameters
- Rest ...items: (T | ConcatArray<T>)[]
 
 Additional items to add to the end of array1.
Returns WorkerPoolResource[]

copyWithin

copyWithin(target: number, start: number, end?: undefined | number): this

Inherited from Array.copyWithin
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:64
Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters
- target: number
  
  If target is negative, it is treated as length+target where length is the length of the array.
- start: number
  
  If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.
- Optional end: undefined | number
  
  If not specified, length of the this object is used as its default value.
Returns this

entries

entries(): IterableIterator<[number, WorkerPoolResource]>

Inherited from Array.entries
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:57
Returns an iterable of key, value pairs for every entry in the array

Returns IterableIterator<[number, WorkerPoolResource]>

every

every(callbackfn: function, thisArg?: any): boolean

Inherited from Array.every
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1286
Determines whether all the members of an array satisfy the specified test.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.
  - - (value: WorkerPoolResource, index: number, array: WorkerPoolResource[]): boolean
    - Parameters
      - value: WorkerPoolResource
      - index: number
      - array: WorkerPoolResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

fill

fill(value: WorkerPoolResource, start?: undefined | number, end?: undefined | number): this

Inherited from Array.fill
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:53
Returns the this object after filling the section identified by start and end with value

Parameters
- value: WorkerPoolResource
  
  value to fill array section with
- Optional start: undefined | number
  
  index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.
- Optional end: undefined | number
  
  index to stop filling the array at. If end is negative, it is treated as length+end.
Returns this

filter

filter<S>(callbackfn: function, thisArg?: any): S[]
filter(callbackfn: function, thisArg?: any): WorkerPoolResource[]

Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1310
Returns the elements of an array that meet the condition specified in a callback function.

Type parameters
- S: WorkerPoolResource
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: WorkerPoolResource, index: number, array: WorkerPoolResource[]): boolean
    - Parameters
      - value: WorkerPoolResource
      - index: number
      - array: WorkerPoolResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns S[]
Inherited from Array.filter
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1316
Returns the elements of an array that meet the condition specified in a callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.
  - - (value: WorkerPoolResource, index: number, array: WorkerPoolResource[]): any
    - Parameters
      - value: WorkerPoolResource
      - index: number
      - array: WorkerPoolResource[]
      Returns any
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns WorkerPoolResource[]

find

find<S>(predicate: function, thisArg?: any): S | undefined
find(predicate: function, thisArg?: any): WorkerPoolResource | undefined

Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:31
Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type parameters
- S: WorkerPoolResource
Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.
  - - (this: void, value: WorkerPoolResource, index: number, obj: WorkerPoolResource[]): boolean
    - Parameters
      - this: void
      - value: WorkerPoolResource
      - index: number
      - obj: WorkerPoolResource[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns S | undefined
Inherited from Array.find
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:32
Parameters
- predicate: function
  - - (value: WorkerPoolResource, index: number, obj: WorkerPoolResource[]): boolean
    - Parameters
      - value: WorkerPoolResource
      - index: number
      - obj: WorkerPoolResource[]
      Returns boolean
- Optional thisArg: any
Returns WorkerPoolResource | undefined

findIndex

findIndex(predicate: function, thisArg?: any): number

Inherited from Array.findIndex
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.core.d.ts:43
Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters
- predicate: function
  
  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.
  - - (value: WorkerPoolResource, index: number, obj: WorkerPoolResource[]): boolean
    - Parameters
      - value: WorkerPoolResource
      - index: number
      - obj: WorkerPoolResource[]
      Returns boolean
- Optional thisArg: any
  
  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.
Returns number

forEach

forEach(callbackfn: function, thisArg?: any): void

Inherited from Array.forEach
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1298
Performs the specified action for each element in an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.
  - - (value: WorkerPoolResource, index: number, array: WorkerPoolResource[]): void
    - Parameters
      - value: WorkerPoolResource
      - index: number
      - array: WorkerPoolResource[]
      Returns void
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns void

includes

includes(searchElement: WorkerPoolResource, fromIndex?: undefined | number): boolean

Inherited from Array.includes
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2016.array.include.d.ts:27
Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters
- searchElement: WorkerPoolResource
  
  The element to search for.
- Optional fromIndex: undefined | number
  
  The position in this array at which to begin searching for searchElement.
Returns boolean

indexOf

indexOf(searchElement: WorkerPoolResource, fromIndex?: undefined | number): number

Inherited from Array.indexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1274
Returns the index of the first occurrence of a value in an array.

Parameters
- searchElement: WorkerPoolResource
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.
Returns number

join

join(separator?: undefined | string): string

Inherited from Array.join
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1231
Adds all the elements of an array separated by the specified separator string.

Parameters
- Optional separator: undefined | string
  
  A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.
Returns string

keys

keys(): IterableIterator<number>

Inherited from Array.keys
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:62
Returns an iterable of keys in the array

Returns IterableIterator<number>

lastIndexOf

lastIndexOf(searchElement: WorkerPoolResource, fromIndex?: undefined | number): number

Inherited from Array.lastIndexOf
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1280
Returns the index of the last occurrence of a specified value in an array.

Parameters
- searchElement: WorkerPoolResource
  
  The value to locate in the array.
- Optional fromIndex: undefined | number
  
  The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.
Returns number

map

map(callbackfn: function, thisArg?: any): U[]

Inherited from Array.map
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1304
Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.
  - - (value: WorkerPoolResource, index: number, array: WorkerPoolResource[]): U
    - Parameters
      - value: WorkerPoolResource
      - index: number
      - array: WorkerPoolResource[]
      Returns U
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns U[]

pop

pop(): WorkerPoolResource | undefined

Inherited from Array.pop
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1211
Removes the last element from an array and returns it.

Returns WorkerPoolResource | undefined

push

push(...items: WorkerPoolResource[]): number

Inherited from Array.push
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1216
Appends new elements to an array, and returns the new length of the array.

Parameters
- Rest ...items: WorkerPoolResource[]
  
  New elements of the Array.
Returns number

reduce

reduce(callbackfn: function): WorkerPoolResource
reduce(callbackfn: function, initialValue: WorkerPoolResource): WorkerPoolResource
reduce(callbackfn: function, initialValue: U): U

Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1322
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: WorkerPoolResource, currentValue: WorkerPoolResource, currentIndex: number, array: WorkerPoolResource[]): WorkerPoolResource
    - Parameters
      - previousValue: WorkerPoolResource
      - currentValue: WorkerPoolResource
      - currentIndex: number
      - array: WorkerPoolResource[]
      Returns WorkerPoolResource
Returns WorkerPoolResource
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1323
Parameters
- callbackfn: function
  - - (previousValue: WorkerPoolResource, currentValue: WorkerPoolResource, currentIndex: number, array: WorkerPoolResource[]): WorkerPoolResource
    - Parameters
      - previousValue: WorkerPoolResource
      - currentValue: WorkerPoolResource
      - currentIndex: number
      - array: WorkerPoolResource[]
      Returns WorkerPoolResource
- initialValue: WorkerPoolResource
Returns WorkerPoolResource
Inherited from Array.reduce
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1329
Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: WorkerPoolResource, currentIndex: number, array: WorkerPoolResource[]): U
    - Parameters
      - previousValue: U
      - currentValue: WorkerPoolResource
      - currentIndex: number
      - array: WorkerPoolResource[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reduceRight

reduceRight(callbackfn: function): WorkerPoolResource
reduceRight(callbackfn: function, initialValue: WorkerPoolResource): WorkerPoolResource
reduceRight(callbackfn: function, initialValue: U): U

Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1335
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: WorkerPoolResource, currentValue: WorkerPoolResource, currentIndex: number, array: WorkerPoolResource[]): WorkerPoolResource
    - Parameters
      - previousValue: WorkerPoolResource
      - currentValue: WorkerPoolResource
      - currentIndex: number
      - array: WorkerPoolResource[]
      Returns WorkerPoolResource
Returns WorkerPoolResource
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1336
Parameters
- callbackfn: function
  - - (previousValue: WorkerPoolResource, currentValue: WorkerPoolResource, currentIndex: number, array: WorkerPoolResource[]): WorkerPoolResource
    - Parameters
      - previousValue: WorkerPoolResource
      - currentValue: WorkerPoolResource
      - currentIndex: number
      - array: WorkerPoolResource[]
      Returns WorkerPoolResource
- initialValue: WorkerPoolResource
Returns WorkerPoolResource
Inherited from Array.reduceRight
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1342
Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type parameters
- U
Parameters
- callbackfn: function
  
  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.
  - - (previousValue: U, currentValue: WorkerPoolResource, currentIndex: number, array: WorkerPoolResource[]): U
    - Parameters
      - previousValue: U
      - currentValue: WorkerPoolResource
      - currentIndex: number
      - array: WorkerPoolResource[]
      Returns U
- initialValue: U
  
  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.
Returns U

reverse

reverse(): WorkerPoolResource[]

Inherited from Array.reverse
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1235
Reverses the elements in an Array.

Returns WorkerPoolResource[]

shift

shift(): WorkerPoolResource | undefined

Inherited from Array.shift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1239
Removes the first element from an array and returns it.

Returns WorkerPoolResource | undefined

slice

slice(start?: undefined | number, end?: undefined | number): WorkerPoolResource[]

Inherited from Array.slice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1245
Returns a section of an array.

Parameters
- Optional start: undefined | number
  
  The beginning of the specified portion of the array.
- Optional end: undefined | number
  
  The end of the specified portion of the array.
Returns WorkerPoolResource[]

some

some(callbackfn: function, thisArg?: any): boolean

Inherited from Array.some
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1292
Determines whether the specified callback function returns true for any element of an array.

Parameters
- callbackfn: function
  
  A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.
  - - (value: WorkerPoolResource, index: number, array: WorkerPoolResource[]): boolean
    - Parameters
      - value: WorkerPoolResource
      - index: number
      - array: WorkerPoolResource[]
      Returns boolean
- Optional thisArg: any
  
  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.
Returns boolean

sort

sort(compareFn?: undefined | function): this

Inherited from Array.sort
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1250
Sorts an array.

Parameters
- Optional compareFn: undefined | function
  
  The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.
Returns this

splice

splice(start: number, deleteCount?: undefined | number): WorkerPoolResource[]
splice(start: number, deleteCount: number, ...items: WorkerPoolResource[]): WorkerPoolResource[]

Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1256
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- Optional deleteCount: undefined | number
  
  The number of elements to remove.
Returns WorkerPoolResource[]
Inherited from Array.splice
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1263
Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters
- start: number
  
  The zero-based location in the array from which to start removing elements.
- deleteCount: number
  
  The number of elements to remove.
- Rest ...items: WorkerPoolResource[]
  
  Elements to insert into the array in place of the deleted elements.
Returns WorkerPoolResource[]

toLocaleString

toLocaleString(): string

Inherited from Array.toLocaleString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1207
Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

Returns string

toString

toString(): string

Inherited from Array.toString
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1203
Returns a string representation of an array.

Returns string

unshift

unshift(...items: WorkerPoolResource[]): number

Inherited from Array.unshift
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es5.d.ts:1268
Inserts new elements at the start of an array.

Parameters
- Rest ...items: WorkerPoolResource[]
  
  Elements to insert at the start of the Array.
Returns number

values

values(): IterableIterator<WorkerPoolResource>

Inherited from Array.values
- Defined in C:/npm/prefix/node_modules/typedoc/node_modules/typescript/lib/lib.es2015.iterable.d.ts:67
Returns an iterable of values in the array

Returns IterableIterator<WorkerPoolResource>

type

type: object

className

className: string = "WorkerPoolCollection"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

value: object

required

required: true = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "WorkerPoolResource"

name

Const WorkerPoolResource

WorkerPoolResource: object

interface: An interface representing WorkerPoolResource. Worker pool of an App Service Environment ARM resource.
extends: ProxyOnlyResource

Optional computeMode

computeMode: ComputeModeOptions

member: {ComputeModeOptions} [computeMode] Shared or dedicated app hosting. Possible values include: 'Shared', 'Dedicated', 'Dynamic'

Optional id

id: undefined | string

member: {string} [id] Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional instanceNames

instanceNames: string[]

member: {string[]} [instanceNames] Names of all instances in the worker pool (read only). NOTE: This property will not be serialized. It can only be populated by the server.

Optional kind

kind: undefined | string

member: {string} [kind] Kind of resource.

Optional name

member: {string} [name] Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkerPoolResource"

Optional sku

sku: SkuDescription

member: {SkuDescription} [sku]

Optional workerCount

workerCount: undefined | number

member: {number} [workerCount] Number of instances in the worker pool.

Optional workerSize

workerSize: undefined | string

member: {string} [workerSize] VM size of the worker pool instances.

Optional workerSizeId

workerSizeId: undefined | number

member: {number} [workerSizeId] Worker size ID for referencing this worker pool.

type

type: object

className

className: string = "WorkerPoolResource"

name

modelProperties

modelProperties: object

computeMode

computeMode: object

serializedName

mapper: object

serializedName

serializedName: string = "billingLocation"

type

type: object

name

Const certificateOrderName

domainName1: object

parameterPath

parameterPath: string = "domainName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "domainName"

constraints

constraints: object

Pattern

Pattern: RegExp = /[a-zA-Z0-9][a-zA-Z0-9\.-]+/

type

type: object

name

Const domainOwnershipIdentifierName

required

required: true = true

serializedName

serializedName: string = "functionName"

type

type: object

name

Const gatewayName

type

type: object

name

Const id

type

type: object

name

Const instanceId

Const osTypeSelected

osTypeSelected: object

parameterPath

parameterPath: string[] = ["options","osTypeSelected"]

mapper

mapper: object

serializedName

serializedName: string = "osTypeSelected"

type

type: object

name

Const premierAddOnName

premierAddOnName: object

parameterPath

parameterPath: string = "premierAddOnName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "premierAddOnName"

type

type: object

name

Const processId

type

type: object

name

Const recommendationId

recommendationId: object

parameterPath

parameterPath: string[] = ["options","recommendationId"]

mapper

mapper: object

serializedName

serializedName: string = "recommendationId"

type

type: object

name

Const relayName

relayName: object

parameterPath

parameterPath: string = "relayName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "relayName"

type

type: object

name

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

constraints

constraints: object

MaxLength

MaxLength: number = 90

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[-\w\._]+[^\.]$/

type

type: object

name

Const routeName

type

type: object

name

Const siteName

type

type: object

name

Const snapshotId

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

Const subscriptionName

type

type: object

name

Const timeGrain0

timeGrain0: object

parameterPath

xenonWorkersEnabled: object

parameterPath

parameterPath: string[] = ["options","xenonWorkersEnabled"]

mapper

mapper: object

serializedName

serializedName: string = "xenonWorkersEnabled"

type

type: object

name